doc: efm32: rtc: tag and include in generated output

Includes the sutb file ncessary to find shared headers without any apis
This commit is contained in:
Karl Palsson 2019-06-25 11:42:47 +00:00
parent 6df301accc
commit 56265ad93f
8 changed files with 52 additions and 16 deletions

View File

@ -1,3 +1,5 @@
/** @addtogroup rtc_defines
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,12 +19,13 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_RTC_H
#define LIBOPENCM3_EFM32_RTC_H
#pragma once
#include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h>
/**@{*/
#define RTC_CTRL (RTC_BASE + 0x000)
#define RTC_CNT (RTC_BASE + 0x004)
#define RTC_COMP0 (RTC_BASE + 0x008)
@ -67,5 +70,4 @@
#define RTC_SYNCBUSY_COMP0 (1 << 1)
#define RTC_SYNCBUSY_CTRL (1 << 0)
#endif
/**@}*/

View File

@ -1,3 +1,11 @@
/** @defgroup rtc_defines RTC Defines
*
* @brief <b>Defined Constants and Types for the Real Time Clock</b>
*
* @ingroup EZR32WG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +25,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_EZR32WG_RTC_H
#define LIBOPENCM3_EFM32_EZR32WG_RTC_H
#pragma once
#include <libopencm3/efm32/common/rtc_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup rtc_defines RTC Defines
*
* @brief <b>Defined Constants and Types for the Real Time Clock</b>
*
* @ingroup EFM32LG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +25,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_LG_RTC_H
#define LIBOPENCM3_EFM32_LG_RTC_H
#pragma once
#include <libopencm3/efm32/common/rtc_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup rtc_defines RTC Defines
*
* @brief <b>Defined Constants and Types for the Real Time Clock</b>
*
* @ingroup EFM32WG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +25,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_WG_RTC_H
#define LIBOPENCM3_EFM32_WG_RTC_H
#pragma once
#include <libopencm3/efm32/common/rtc_common.h>
#endif

View File

@ -0,0 +1,16 @@
/** @addtogroup rtc_file RTC peripheral API
* @ingroup peripheral_apis
* @brief Real Time Clock helper functions.
*
* <b>NO</b> helper functions exist. Only header definitions are available.
* Delete these lines if/when you add actual helper APIs.
* @sa rtc_defines
* @copyright See @ref lgpl_license
*/
#include <libopencm3/efm32/rtc.h>
/**@{*/
/**@}*/

View File

@ -50,6 +50,7 @@ OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += rmu_common.o
OBJS += rtc_common.o
OBJS += timer_common.o
OBJS += wdog_common.o

View File

@ -50,6 +50,7 @@ OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += rmu_common.o
OBJS += rtc_common.o
OBJS += timer_common.o
OBJS += wdog_common.o

View File

@ -50,6 +50,7 @@ OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += rmu_common.o
OBJS += rtc_common.o
OBJS += timer_common.o
OBJS += wdog_common.o