From 7ed7ff2280bd0d2a73ca2577a6da212b510c7694 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Tue, 8 May 2012 11:39:47 -0400
Subject: stm32f1: stm32.h: Add Doxygen comments.

Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
---
 libmaple/stm32f1/include/series/stm32.h | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'libmaple/stm32f1/include')

diff --git a/libmaple/stm32f1/include/series/stm32.h b/libmaple/stm32f1/include/series/stm32.h
index bcc938b..d7ec2ea 100644
--- a/libmaple/stm32f1/include/series/stm32.h
+++ b/libmaple/stm32f1/include/series/stm32.h
@@ -44,10 +44,15 @@ extern "C" {
  *
  * You can use these F1 line defines if porting libmaple to support
  * MCUs on other lines. */
+/** STM32F1 performance line. */
 #define STM32_F1_LINE_PERFORMANCE       0
+/** STM32F1 value line. */
 #define STM32_F1_LINE_VALUE             1
+/** STM32F1 access line. */
 #define STM32_F1_LINE_ACCESS            2
+/** STM32F1 USB access line. */
 #define STM32_F1_LINE_USB_ACCESS        3
+/** STM32F1 connectivity line. */
 #define STM32_F1_LINE_CONNECTIVITY      4
 
 /*
@@ -166,6 +171,23 @@ extern "C" {
 #error "Bad STM32F1 configuration. Check STM32F1 <series/stm32.h> header."
 #endif
 
+/*
+ * Doxygen
+ */
+
+#ifdef __DOXYGEN_PREDEFINED_HACK
+
+/**
+ * @brief STM32 line value for the STM32F1 MCU being targeted.
+ *
+ * At time of writing, allowed values are: STM32_F1_LINE_PERFORMANCE,
+ * STM32_F1_LINE_VALUE. This set of values may expand as libmaple adds
+ * support for more STM32F1 lines.
+ */
+#define STM32_F1_LINE
+
+#endif /* __DOXYGEN_PREDEFINED_HACK */
+
 #ifdef __cplusplus
 }
 #endif
-- 
cgit v1.2.3