Minor documentation improvements.

2012-08-18 10:58:52 +00:00
parent 0598d622d8
commit 7750783809
4 changed files with 15 additions and 10 deletions
@@ -110,7 +110,18 @@
 			#define INTC_IRQ_LINE(IRQIndex)   (IRQIndex % 32)

 		/* Function Prototypes: */
+			/** Initializes the interrupt controller ready to handle interrupts. This must be called at the
+			 *  start of the user program before any interrupts are registered or enabled.
+			 */
 			void INTC_Init(void);			
+			
+			/** Retrieves the associated interrupt handler for the interrupt group currently being fired. This
+			 *  is called directly from the exception handler routine before dispatching to the ISR.
+			 *
+			 *  \param[in] InterruptLevel  Priority level of the interrupt.
+			 *
+			 *  \return Pointer to the associated interrupt handler function, or NULL if no handler set.
+			 */
 			InterruptHandlerPtr_t INTC_GetInterruptHandler(const uint_reg_t InterruptLevel);

 		/* Inline Functions: */