From 58fb7e2e586acc0263c1a228290327d18fdd184b Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Thu, 19 May 2011 15:00:45 -0400
Subject: iwdg: Doxygen comments

---
 libmaple/iwdg.c |  7 ++++---
 libmaple/iwdg.h | 21 +++++++++++++--------
 2 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/libmaple/iwdg.c b/libmaple/iwdg.c
index 3d67ee8..647cc15 100644
--- a/libmaple/iwdg.c
+++ b/libmaple/iwdg.c
@@ -32,10 +32,11 @@
 /**
  * @brief Initialise and start the watchdog
  *
- * The prescaler and reload set the timeout.  A prescaler of 3 divides
- * the 40 kHz clock by 32 and gives roughly 1 ms per reload.
+ * The prescaler and reload set the timeout.  For example, a prescaler
+ * of IWDG_PRE_32 divides the 40 kHz clock by 32 and gives roughly 1
+ * ms per reload.
  *
- * @param prescaler Prescaler for the 40 KHz IWDG clock.
+ * @param prescaler Prescaler for the 40 kHz IWDG clock.
  * @param reload Independent watchdog counter reload value.
  */
 void iwdg_init(iwdg_prescaler prescaler, uint16 reload) {
diff --git a/libmaple/iwdg.h b/libmaple/iwdg.h
index 551bb12..7845578 100644
--- a/libmaple/iwdg.h
+++ b/libmaple/iwdg.h
@@ -58,6 +58,7 @@ typedef struct iwdg_reg_map {
     __io uint32 SR;             /**< Status register */
 } iwdg_reg_map;
 
+/** Independent watchdog base pointer */
 #define IWDG_BASE                       ((struct iwdg_reg_map*)0x40003000)
 
 /*
@@ -88,15 +89,19 @@ typedef struct iwdg_reg_map {
 #define IWDG_SR_RVU                     BIT(IWDG_SR_RVU_BIT)
 #define IWDG_SR_PVU                     BIT(IWDG_SR_PVU_BIT)
 
-/** Independent watchdog prescalers */
+/**
+ * @brief Independent watchdog prescalers.
+ *
+ * These divide the 40 kHz IWDG clock.
+ */
 typedef enum iwdg_prescaler {
-    IWDG_PRE_4 = IWDG_PR_DIV_4,
-    IWDG_PRE_8 = IWDG_PR_DIV_8,
-    IWDG_PRE_16 = IWDG_PR_DIV_16,
-    IWDG_PRE_32 = IWDG_PR_DIV_32,
-    IWDG_PRE_64 = IWDG_PR_DIV_64,
-    IWDG_PRE_128 = IWDG_PR_DIV_128,
-    IWDG_PRE_256 = IWDG_PR_DIV_256
+    IWDG_PRE_4 = IWDG_PR_DIV_4,     /**< Divide by 4 */
+    IWDG_PRE_8 = IWDG_PR_DIV_8,     /**< Divide by 8 */
+    IWDG_PRE_16 = IWDG_PR_DIV_16,   /**< Divide by 16 */
+    IWDG_PRE_32 = IWDG_PR_DIV_32,   /**< Divide by 32 */
+    IWDG_PRE_64 = IWDG_PR_DIV_64,   /**< Divide by 64 */
+    IWDG_PRE_128 = IWDG_PR_DIV_128, /**< Divide by 128 */
+    IWDG_PRE_256 = IWDG_PR_DIV_256  /**< Divide by 256 */
 } iwdg_prescaler;
 
 void iwdg_init(iwdg_prescaler prescaler, uint16 reload);
-- 
cgit v1.2.3