From 40cde559a72b54cb8f5f68c438666defc20c8a32 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Fri, 31 Jul 2015 03:48:03 +0000 Subject: [PATCH] stm32: f24: doxygen updates for flash program width. More doxygen, more better. --- include/libopencm3/stm32/common/flash_common_f24.h | 5 +++++ lib/stm32/common/flash_common_f24.c | 3 +-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/include/libopencm3/stm32/common/flash_common_f24.h b/include/libopencm3/stm32/common/flash_common_f24.h index c33d2dba..3548518a 100644 --- a/include/libopencm3/stm32/common/flash_common_f24.h +++ b/include/libopencm3/stm32/common/flash_common_f24.h @@ -78,10 +78,15 @@ #define FLASH_CR_SNB_MASK 0x1f #define FLASH_CR_PROGRAM_MASK 0x3 #define FLASH_CR_PROGRAM_SHIFT 8 +/** @defgroup flash_cr_program_width Flash programming width +@ingroup flash_group + +@{*/ #define FLASH_CR_PROGRAM_X8 0 #define FLASH_CR_PROGRAM_X16 1 #define FLASH_CR_PROGRAM_X32 2 #define FLASH_CR_PROGRAM_X64 3 +/**@}*/ /* --- FLASH_OPTCR values -------------------------------------------------- */ diff --git a/lib/stm32/common/flash_common_f24.c b/lib/stm32/common/flash_common_f24.c index 7d1ad373..4879c68d 100644 --- a/lib/stm32/common/flash_common_f24.c +++ b/lib/stm32/common/flash_common_f24.c @@ -32,8 +32,7 @@ Set the programming word width. Note carefully the power supply voltage restrictions under which the different word sizes may be used. See the programming manual for more information. - -@param psize: 0 (8-bit), 1 (16-bit), 2 (32-bit), 3 (64-bit) +@param[in] psize The programming word width one of: @ref flash_cr_program_width */ static inline void flash_set_program_size(uint32_t psize)