doc: efm32: emu: tag for doxygen properly

Requires a stub .c file to make the common files be included until we
build some APIs.
This commit is contained in:
Karl Palsson 2019-06-25 10:58:19 +00:00
parent 764fbed9c8
commit 4c01e47aed
8 changed files with 51 additions and 16 deletions

View File

@ -1,3 +1,5 @@
/** @addtogroup emu_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_EMU_H
#define LIBOPENCM3_EFM32_EMU_H
#pragma once
#include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h>
/**@{*/
#define EMU_CTRL MMIO32(EMU_BASE + 0x000)
#define EMU_LOCK MMIO32(EMU_BASE + 0x008)
#define EMU_AUXCTRL MMIO32(EMU_BASE + 0x024)
@ -185,5 +188,4 @@
(((v) << EMU_BUBODUNREGCAL_THRES_SHIFT) & \
EMU_BUBODUNREGCAL_THRES_MASK)
#endif
/**@}*/

View File

@ -1,3 +1,11 @@
/** @defgroup emu_defines EMU Defines
*
* @brief <b>Defined Constants and Types for the Energy Management Unit</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_EMU_H
#define LIBOPENCM3_EFM32_EZR32WG_EMU_H
#pragma once
#include <libopencm3/efm32/common/emu_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup emu_defines EMU Defines
*
* @brief <b>Defined Constants and Types for the Energy Management Unit</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_EMU_H
#define LIBOPENCM3_EFM32_LG_EMU_H
#pragma once
#include <libopencm3/efm32/common/emu_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup emu_defines EMU Defines
*
* @brief <b>Defined Constants and Types for the Energy Management Unit</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_EMU_H
#define LIBOPENCM3_EFM32_WG_EMU_H
#pragma once
#include <libopencm3/efm32/common/emu_common.h>
#endif

View File

@ -0,0 +1,15 @@
/** @addtogroup emu_file EMU peripheral API
* @ingroup peripheral_apis
* @brief Energy Management Unit 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/emu.h>
/**@{*/
/**@}*/

View File

@ -43,6 +43,7 @@ OBJS += burtc_common.o
OBJS += cmu_common.o
OBJS += dac_common.o
OBJS += dma_common.o
OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += prs_common.o
OBJS += timer_common.o

View File

@ -43,6 +43,7 @@ OBJS += burtc_common.o
OBJS += cmu_common.o
OBJS += dac_common.o
OBJS += dma_common.o
OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += prs_common.o
OBJS += timer_common.o

View File

@ -43,6 +43,7 @@ OBJS += burtc_common.o
OBJS += cmu_common.o
OBJS += dac_common.o
OBJS += dma_common.o
OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += prs_common.o
OBJS += timer_common.o