From 3af30a19f4cd7ce0ce9ea29c7fa61a28ce8169f2 Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@leaflabs.com>
Date: Mon, 22 Aug 2011 19:22:56 -0400
Subject: nvic.h: Doxygen

---
 libmaple/nvic.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/libmaple/nvic.h b/libmaple/nvic.h
index 8fe3136..1630bc1 100644
--- a/libmaple/nvic.h
+++ b/libmaple/nvic.h
@@ -60,8 +60,15 @@ typedef struct nvic_reg_map {
 #define NVIC_BASE                       ((struct nvic_reg_map*)0xE000E100)
 
 /**
- * Interrupt vector table interrupt numbers.  Each enumerator is the
- * position of the corresponding interrupt in the vector table. */
+ * @brief Interrupt vector table interrupt numbers.
+ *
+ * Each positive-valued enumerator is the position of the
+ * corresponding interrupt in the vector table.  Negative-valued
+ * enumerators correspond to interrupts controlled by the system
+ * handler block.
+ *
+ * @see scb.h
+ */
 typedef enum nvic_irq_num {
     NVIC_NMI            = -14,  /**< Non-maskable interrupt */
     NVIC_HARDFAULT      = -13,  /**< Hard fault (all class of fault) */
-- 
cgit v1.2.3