aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2012-05-09 17:53:04 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2012-05-09 17:53:45 -0400
commitca34bcaa8cf5ac129694cbe11e9b0b2fa16e6d9d (patch)
tree622e4adbd79b6f3fa672437f60b5eeb76b1d3bd3
parent94d95639c124ebff02a9944237ca9c1764c9cca9 (diff)
downloadlibrambutan-ca34bcaa8cf5ac129694cbe11e9b0b2fa16e6d9d.tar.gz
librambutan-ca34bcaa8cf5ac129694cbe11e9b0b2fa16e6d9d.zip
flash.h: Doxygen.
Document FLASH_BASE once. This is due to restrictions in the documentation build system. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
-rw-r--r--libmaple/include/libmaple/flash.h5
-rw-r--r--libmaple/stm32f1/include/series/flash.h1
-rw-r--r--libmaple/stm32f2/include/series/flash.h1
3 files changed, 5 insertions, 2 deletions
diff --git a/libmaple/include/libmaple/flash.h b/libmaple/include/libmaple/flash.h
index d84ded1..943e466 100644
--- a/libmaple/include/libmaple/flash.h
+++ b/libmaple/include/libmaple/flash.h
@@ -64,6 +64,11 @@ extern "C"{
*/
#include <series/flash.h>
+#ifdef __DOXYGEN__
+/** Flash register map base pointer. */
+#define FLASH_BASE
+#endif
+
/*
* Flash routines
*/
diff --git a/libmaple/stm32f1/include/series/flash.h b/libmaple/stm32f1/include/series/flash.h
index bb335e7..729cf9a 100644
--- a/libmaple/stm32f1/include/series/flash.h
+++ b/libmaple/stm32f1/include/series/flash.h
@@ -58,7 +58,6 @@ typedef struct flash_reg_map {
__io uint32 WRPR; /**< Write protection register */
} flash_reg_map;
-/** Flash register map base pointer */
#define FLASH_BASE ((struct flash_reg_map*)0x40022000)
/*
diff --git a/libmaple/stm32f2/include/series/flash.h b/libmaple/stm32f2/include/series/flash.h
index 10b8717..f3c650b 100644
--- a/libmaple/stm32f2/include/series/flash.h
+++ b/libmaple/stm32f2/include/series/flash.h
@@ -56,7 +56,6 @@ typedef struct flash_reg_map {
__io uint32 OPTCR; /**< Option control register */
} flash_reg_map;
-/** Flash register map base pointer */
#define FLASH_BASE ((struct flash_reg_map*)0x40023C00)
/*