From b146fd6aa76360261e77c328c33019923869820b Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Fri, 6 Mar 2020 01:14:17 +0000 Subject: [PATCH] doc: stm32: flash: tidy up doxygen warnings and broken groupings --- .../libopencm3/stm32/common/flash_common_f24.h | 17 +++++++++++------ .../stm32/common/flash_common_idcache.h | 5 +++++ include/libopencm3/stm32/f3/flash.h | 2 ++ include/libopencm3/stm32/f7/flash.h | 2 +- 4 files changed, 19 insertions(+), 7 deletions(-) diff --git a/include/libopencm3/stm32/common/flash_common_f24.h b/include/libopencm3/stm32/common/flash_common_f24.h index bc71eacf..27b1ee16 100644 --- a/include/libopencm3/stm32/common/flash_common_f24.h +++ b/include/libopencm3/stm32/common/flash_common_f24.h @@ -61,12 +61,9 @@ #define FLASH_OPTCR1 MMIO32(FLASH_MEM_INTERFACE_BASE + 0x18) /*@}*/ -/** @defgroup flash_acr_values FLASH_ACR values - * @ingroup flash_registers - * @brief Access Control register values +/** @defgroup flash_latency FLASH Wait States +@ingroup flash_defines @{*/ -#define FLASH_ACR_LATENCY_SHIFT 0 -#define FLASH_ACR_LATENCY_MASK 0x0f #define FLASH_ACR_LATENCY(w) ((w) & FLASH_ACR_LATENCY_MASK) #define FLASH_ACR_LATENCY_0WS 0x00 #define FLASH_ACR_LATENCY_1WS 0x01 @@ -76,8 +73,16 @@ #define FLASH_ACR_LATENCY_5WS 0x05 #define FLASH_ACR_LATENCY_6WS 0x06 #define FLASH_ACR_LATENCY_7WS 0x07 -#define FLASH_ACR_PRFTEN (1 << 8) /*@}*/ +#define FLASH_ACR_LATENCY_SHIFT 0 +#define FLASH_ACR_LATENCY_MASK 0x0f + +/** @defgroup flash_acr_values FLASH_ACR values + * @ingroup flash_registers + * @brief Access Control register values + * @{*/ +#define FLASH_ACR_PRFTEN (1 << 8) +/**@}*/ /* --- FLASH_SR values ----------------------------------------------------- */ diff --git a/include/libopencm3/stm32/common/flash_common_idcache.h b/include/libopencm3/stm32/common/flash_common_idcache.h index ac4ecc96..ab834988 100644 --- a/include/libopencm3/stm32/common/flash_common_idcache.h +++ b/include/libopencm3/stm32/common/flash_common_idcache.h @@ -22,10 +22,15 @@ #include /**@{*/ + +/** @addtogroup flash_acr_values + * @{ + */ #define FLASH_ACR_DCRST (1 << 12) #define FLASH_ACR_ICRST (1 << 11) #define FLASH_ACR_DCEN (1 << 10) #define FLASH_ACR_ICEN (1 << 9) +/**@}*/ BEGIN_DECLS diff --git a/include/libopencm3/stm32/f3/flash.h b/include/libopencm3/stm32/f3/flash.h index a978ebf7..ed0e2b93 100644 --- a/include/libopencm3/stm32/f3/flash.h +++ b/include/libopencm3/stm32/f3/flash.h @@ -65,7 +65,9 @@ #define FLASH_ACR_HLFCYA (1 << 3) #define FLASH_ACR_LATENCY_SHIFT 0 #define FLASH_ACR_LATENCY_MASK 0x0f +/** @defgroup flash_latency FLASH Wait States @{*/ #define FLASH_ACR_LATENCY(w) ((w) & FLASH_ACR_LATENCY_MASK) +/**@}*/ /* --- FLASH_SR values ----------------------------------------------------- */ diff --git a/include/libopencm3/stm32/f7/flash.h b/include/libopencm3/stm32/f7/flash.h index f5e68d7a..0047da88 100644 --- a/include/libopencm3/stm32/f7/flash.h +++ b/include/libopencm3/stm32/f7/flash.h @@ -53,7 +53,7 @@ /* --- FLASH_ACR values ---------------------------------------------------- */ -/** @addtogroup flash_acr_values FLASH_ACR_VALUES +/** @addtogroup flash_acr_values FLASH_ACR values * @ingroup flash_registers @{*/ #define FLASH_ACR_ARTRST (1 << 11)