doc: efm32: letimer: include tags for doxygen
Include a stub .c file to document the shared headers.
This commit is contained in:
parent
25dc3a9b4b
commit
c92f3dc0ad
|
@ -1,3 +1,5 @@
|
|||
/** @addtogroup letimer_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_LETIMER_H
|
||||
#define LIBOPENCM3_EFM32_LETIMER_H
|
||||
#pragma once
|
||||
|
||||
#include <libopencm3/efm32/memorymap.h>
|
||||
#include <libopencm3/cm3/common.h>
|
||||
|
||||
/**@{*/
|
||||
|
||||
#define LETIMER_CTRL(base) ((base) + 0x000)
|
||||
#define LETIMER_CMD(base) ((base) + 0x004)
|
||||
#define LETIMER_STATUS(base) ((base) + 0x008)
|
||||
|
@ -161,5 +164,4 @@
|
|||
#define LETIMER0_SYNCBUSY LETIMER_SYNCBUSY(LETIMER0)
|
||||
#define LETIMER0_ROUTE LETIMER_ROUTE(LETIMER0)
|
||||
|
||||
#endif
|
||||
|
||||
/**@}*/
|
|
@ -1,3 +1,11 @@
|
|||
/** @defgroup letimer_defines LETIMER Defines
|
||||
*
|
||||
* @brief <b>Defined Constants and Types for the Low Energy Timer</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_LETIMER_H
|
||||
#define LIBOPENCM3_EFM32_EZR32WG_LETIMER_H
|
||||
#pragma once
|
||||
|
||||
#include <libopencm3/efm32/common/letimer_common.h>
|
||||
|
||||
#endif
|
||||
|
|
|
@ -1,3 +1,11 @@
|
|||
/** @defgroup letimer_defines LETIMER Defines
|
||||
*
|
||||
* @brief <b>Defined Constants and Types for the Low Energy Timer</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_LETIMER_H
|
||||
#define LIBOPENCM3_EFM32_LG_LETIMER_H
|
||||
#pragma once
|
||||
|
||||
#include <libopencm3/efm32/common/letimer_common.h>
|
||||
|
||||
#endif
|
||||
|
|
|
@ -1,3 +1,11 @@
|
|||
/** @defgroup letimer_defines LETIMER Defines
|
||||
*
|
||||
* @brief <b>Defined Constants and Types for the Low Energy Timer</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_LETIMER_H
|
||||
#define LIBOPENCM3_EFM32_WG_LETIMER_H
|
||||
#pragma once
|
||||
|
||||
#include <libopencm3/efm32/common/letimer_common.h>
|
||||
|
||||
#endif
|
||||
|
|
|
@ -0,0 +1,15 @@
|
|||
/** @addtogroup letimer_file LETIMER peripheral API
|
||||
* @ingroup peripheral_apis
|
||||
* @brief Low Energy Timer helper functions.
|
||||
*
|
||||
* <b>NO</b> helper functions exist. Only header definitions are available.
|
||||
* Delete these lines if/when you add actual helper APIs.
|
||||
* @copyright See @ref lgpl_license
|
||||
*/
|
||||
|
||||
#include <libopencm3/efm32/letimer.h>
|
||||
|
||||
/**@{*/
|
||||
|
||||
/**@}*/
|
||||
|
|
@ -46,6 +46,7 @@ OBJS += dma_common.o
|
|||
OBJS += emu_common.o
|
||||
OBJS += gpio_common.o
|
||||
OBJS += i2c_common.o
|
||||
OBJS += letimer_common.o
|
||||
OBJS += prs_common.o
|
||||
OBJS += timer_common.o
|
||||
|
||||
|
|
|
@ -46,6 +46,7 @@ OBJS += dma_common.o
|
|||
OBJS += emu_common.o
|
||||
OBJS += gpio_common.o
|
||||
OBJS += i2c_common.o
|
||||
OBJS += letimer_common.o
|
||||
OBJS += prs_common.o
|
||||
OBJS += timer_common.o
|
||||
|
||||
|
|
|
@ -46,6 +46,7 @@ OBJS += dma_common.o
|
|||
OBJS += emu_common.o
|
||||
OBJS += gpio_common.o
|
||||
OBJS += i2c_common.o
|
||||
OBJS += letimer_common.o
|
||||
OBJS += prs_common.o
|
||||
OBJS += timer_common.o
|
||||
|
||||
|
|
Loading…
Reference in New Issue