diff options
author | Karl Palsson <karlp@tweak.net.au> | 2019-06-22 04:02:02 +0300 |
---|---|---|
committer | Karl Palsson <karlp@tweak.net.au> | 2019-06-22 04:38:20 +0300 |
commit | 35657bdb614a4e78c3de9e434c9ac2f47ad50855 (patch) | |
tree | 97c03c2c56f756d0c6cff512f1c223b193978472 /include/libopencm3 | |
parent | 093edfb8810c03513396abbaeab391d234d21fe9 (diff) |
doc: efm32: wdog: enable documentation via peripheral_apis
Diffstat (limited to 'include/libopencm3')
-rw-r--r-- | include/libopencm3/efm32/common/wdog_common.h | 10 | ||||
-rw-r--r-- | include/libopencm3/efm32/common/wdog_common_hglg.h | 17 | ||||
-rw-r--r-- | include/libopencm3/efm32/ezr32wg/wdog.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/hg/wdog.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/lg/wdog.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/wg/wdog.h | 13 |
6 files changed, 48 insertions, 31 deletions
diff --git a/include/libopencm3/efm32/common/wdog_common.h b/include/libopencm3/efm32/common/wdog_common.h index d4dad2da..1168d129 100644 --- a/include/libopencm3/efm32/common/wdog_common.h +++ b/include/libopencm3/efm32/common/wdog_common.h @@ -1,3 +1,5 @@ +/** @addtogroup wdog_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_WDOG_H -#define LIBOPENCM3_EFM32_WDOG_H +#pragma once #include <libopencm3/efm32/memorymap.h> #include <libopencm3/cm3/common.h> +/**@{*/ + #define WDOG_CTRL MMIO32(WDOG_BASE + 0x000) #define WDOG_CMD MMIO32(WDOG_BASE + 0x004) #define WDOG_SYNCBUSY MMIO32(WDOG_BASE + 0x008) @@ -72,5 +75,4 @@ #define WDOG_SYNCBUSY_CMD (1 << 1) #define WDOG_SYNCBUSY_CTRL (1 << 0) -#endif - +/**@}*/
\ No newline at end of file diff --git a/include/libopencm3/efm32/common/wdog_common_hglg.h b/include/libopencm3/efm32/common/wdog_common_hglg.h index 4c067184..700c48ba 100644 --- a/include/libopencm3/efm32/common/wdog_common_hglg.h +++ b/include/libopencm3/efm32/common/wdog_common_hglg.h @@ -1,3 +1,5 @@ +/** @addtogroup wdog_defines + */ /* * This file is part of the libopencm3 project. * @@ -17,15 +19,13 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -/** @cond */ -#if defined(LIBOPENCM3_WDOG_H) -/** @endcond */ -#ifndef LIBOPENCM3_EFM32_WDOG_COMMON_HGLG_H -#define LIBOPENCM3_EFM32_WDOG_COMMON_HGLG_H +#pragma once #include <libopencm3/efm32/memorymap.h> #include <libopencm3/cm3/common.h> +/**@{*/ + #define WDOG_CTRL MMIO32(WDOG_BASE + 0x000) #define WDOG_CMD MMIO32(WDOG_BASE + 0x004) #define WDOG_SYNCBUSY MMIO32(WDOG_BASE + 0x008) @@ -75,9 +75,4 @@ #define WDOG_SYNCBUSY_CMD (1 << 1) #define WDOG_SYNCBUSY_CTRL (1 << 0) -#endif -/** @cond */ -#else -#warning "wdog_common_hglg.h should not be included explicitly, only via wdog.h" -#endif -/** @endcond */ +/**@}*/
\ No newline at end of file diff --git a/include/libopencm3/efm32/ezr32wg/wdog.h b/include/libopencm3/efm32/ezr32wg/wdog.h index 0446680c..e2c7fd93 100644 --- a/include/libopencm3/efm32/ezr32wg/wdog.h +++ b/include/libopencm3/efm32/ezr32wg/wdog.h @@ -1,3 +1,11 @@ +/** @defgroup wdog_defines WDOG Defines + * + * @brief <b>Defined Constants and Types for the Watchdog module</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_WDOG_H -#define LIBOPENCM3_EFM32_EZR32WG_WDOG_H +#pragma once #include <libopencm3/efm32/common/wdog_common.h> - -#endif diff --git a/include/libopencm3/efm32/hg/wdog.h b/include/libopencm3/efm32/hg/wdog.h index 2eb8a478..949896b7 100644 --- a/include/libopencm3/efm32/hg/wdog.h +++ b/include/libopencm3/efm32/hg/wdog.h @@ -1,3 +1,11 @@ +/** @defgroup wdog_defines WDOG Defines + * + * @brief <b>Defined Constants and Types for the Watchdog module</b> + * + * @ingroup EFM32HG_defines + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -15,9 +23,6 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -#ifndef LIBOPENCM3_WDOG_H -#define LIBOPENCM3_WDOG_H +#pragma once #include <libopencm3/efm32/common/wdog_common_hglg.h> - -#endif diff --git a/include/libopencm3/efm32/lg/wdog.h b/include/libopencm3/efm32/lg/wdog.h index ea9a4812..ba657c2a 100644 --- a/include/libopencm3/efm32/lg/wdog.h +++ b/include/libopencm3/efm32/lg/wdog.h @@ -1,3 +1,11 @@ +/** @defgroup wdog_defines WDOG Defines + * + * @brief <b>Defined Constants and Types for the Watchdog module</b> + * + * @ingroup EFM32LG_defines + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -15,9 +23,6 @@ * along with this library. If not, see <http://www.gnu.org/licenses/>. */ -#ifndef LIBOPENCM3_WDOG_H -#define LIBOPENCM3_WDOG_H +#pragma once #include <libopencm3/efm32/common/wdog_common.h> - -#endif diff --git a/include/libopencm3/efm32/wg/wdog.h b/include/libopencm3/efm32/wg/wdog.h index bec00e9d..9f32353c 100644 --- a/include/libopencm3/efm32/wg/wdog.h +++ b/include/libopencm3/efm32/wg/wdog.h @@ -1,3 +1,11 @@ +/** @defgroup wdog_defines WDOG Defines + * + * @brief <b>Defined Constants and Types for the Watchdog module</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_WDOG_H -#define LIBOPENCM3_EFM32_WG_WDOG_H +#pragma once #include <libopencm3/efm32/common/wdog_common.h> - -#endif |