Adding in doxygen comment headers

Moving many of the functions from the old format of inline comments to
the newer doxygen format.

Change-Id: Ib0fe0d8627d7cd90219385a3ab627da8f9637d98
Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>

arch/arm/core/cortex_m/scb.c

@@ -38,7 +38,6 @@ definitions and more complex routines, if needed.
  *
  * @return N/A
  */
-
 void _ScbSystemReset(void)
 {
 	union __aircr reg;
@@ -51,8 +50,8 @@ void _ScbSystemReset(void)
 
 /**
  *
- * @brief Set the number of priority groups based on the number
- *                      of exception priorities desired
+ * @brief Set the number of priority groups based on the number of exception
+ * priorities desired
  *
  * Exception priorities can be divided in priority groups, inside which there is
  * no preemption. The priorities inside a group are only used to decide which
@@ -60,11 +59,11 @@ void _ScbSystemReset(void)
  *
  * The number of priorities has to be a power of two, from 1 to 128.
  *
+ * @param n the number of priorities
+ *
  * @return N/A
  */
-
-void _ScbNumPriGroupSet(unsigned int n /* number of priorities */
-			)
+void _ScbNumPriGroupSet(unsigned int n)
 {
 	unsigned int set;
 	union __aircr reg;

arch/arm/core/fatal.c

@@ -61,15 +61,16 @@ const NANO_ESF _default_esf = {0xdeaddead, /* a1 */
  * fatal error does not have a hardware generated ESF, the caller should either
  * create its own or use a pointer to the global default ESF <_default_esf>.
  *
+ * @param reason the reason that the handler was called
+ * @param pEsf pointer to the exception stack frame
+ *
  * @return This function does not return.
  *
  * \NOMANUAL
  */
 
-FUNC_NORETURN void _NanoFatalErrorHandler(
-	unsigned int reason, /* reason that handler was called */
-	const NANO_ESF *pEsf /* pointer to exception stack frame */
-	)
+FUNC_NORETURN void _NanoFatalErrorHandler(unsigned int reason,
+					  const NANO_ESF *pEsf)
 {
 	switch (reason) {
 	case _NANO_ERR_INVALID_TASK_EXIT:

arch/arm/core/fault.c

@@ -134,8 +134,7 @@ static void _FaultThreadShow(const NANO_ESF *esf)
  * \NOMANUAL
  */
 
-static void _MpuFault(const NANO_ESF *esf,
-					    int fromHardFault)
+static void _MpuFault(const NANO_ESF *esf, int fromHardFault)
 {
 	PR_EXC("***** MPU FAULT *****\n");
 
@@ -169,8 +168,7 @@ static void _MpuFault(const NANO_ESF *esf,
  * \NOMANUAL
  */
 
-static void _BusFault(const NANO_ESF *esf,
-					    int fromHardFault)
+static void _BusFault(const NANO_ESF *esf, int fromHardFault)
 {
 	PR_EXC("***** BUS FAULT *****\n");
 
@@ -294,8 +292,7 @@ static void _DebugMonitor(const NANO_ESF *esf)
  * \NOMANUAL
  */
 
-static void _ReservedException(const NANO_ESF *esf,
-						     int fault)
+static void _ReservedException(const NANO_ESF *esf, int fault)
 {
 	PR_EXC("***** %s %d) *****\n",
 	       fault < 16 ? "Reserved Exception (" : "Spurious interrupt (IRQ ",
@@ -362,15 +359,15 @@ static void _FaultDump(const NANO_ESF *esf, int fault)
  * interrupt was already being handled, it is passed a pointer to both and has
  * to find out on which the ESP is present.
  *
+ * @param msp pointer to potential ESF on MSP
+ * @param psp pointer to potential ESF on PSP
+ *
  * @return This function does not return.
  *
  * \NOMANUAL
  */
 
-void _Fault(
-	const NANO_ESF *msp, /* pointer to potential ESF on MSP */
-	const NANO_ESF *psp  /* pointer to potential ESF on PSP */
-	)
+void _Fault( const NANO_ESF *msp, const NANO_ESF *psp)
 {
 	const NANO_ESF *esf = _ScbIsNestedExc() ? msp : psp;
 	int fault = _ScbActiveVectorGet();

arch/arm/core/irq_manage.c

@@ -45,7 +45,6 @@ extern void __reserved(void);
  *
  * @return N/A
  */
-
 void _irq_handler_set(unsigned int irq,
 						void (*old)(void *arg),
 						void (*new)(void *arg),
@@ -73,7 +72,6 @@ void _irq_handler_set(unsigned int irq,
  *
  * @return N/A
  */
-
 void irq_enable(unsigned int irq)
 {
 	/* before enabling interrupts, ensure that interrupt is cleared */
@@ -90,7 +88,6 @@ void irq_enable(unsigned int irq)
  *
  * @return N/A
  */
-
 void irq_disable(unsigned int irq)
 {
 	_NvicIrqDisable(irq);
@@ -111,7 +108,6 @@ void irq_disable(unsigned int irq)
  *
  * @return N/A
  */
-
 void _irq_priority_set(unsigned int irq,
 					     unsigned int prio)
 {
@@ -130,7 +126,6 @@ void _irq_priority_set(unsigned int irq,
  *
  * @return N/A
  */
-
 void _irq_spurious(void *unused)
 {
 	ARG_UNUSED(unused);
@@ -149,7 +144,6 @@ void _irq_spurious(void *unused)
  *
  * @return the interrupt line number
  */
-
 int irq_connect(unsigned int irq,
 					    unsigned int prio,
 					    void (*isr)(void *arg),
@@ -172,7 +166,6 @@ int irq_connect(unsigned int irq,
  *
  * @return N/A
  */
-
 void _irq_disconnect(unsigned int irq)
 {
 	_irq_handler_set(irq, _sw_isr_table[irq].isr, _irq_spurious, NULL);

arch/arm/core/sys_fatal_error_handler.c

@@ -61,15 +61,15 @@ static inline void nonEssentialTaskAbort(void)
  * implementation to take other actions, such as logging error (or debug)
  * information to a persistent repository and/or rebooting the system.
  *
+ * @param reason fatal error reason
+ * @param pEsf pointer to exception stack frame
+ *
  * @return N/A
  *
  * \NOMANUAL
  */
 
-void _SysFatalErrorHandler(
-	unsigned int reason, /* fatal error reason */
-	const NANO_ESF * pEsf /* pointer to exception stack frame */
-	)
+void _SysFatalErrorHandler( unsigned int reason, const NANO_ESF * pEsf)
 {
 	nano_context_type_t curCtx = sys_execution_context_type_get();
 

arch/arm/core/thread.c

@@ -87,19 +87,21 @@ static ALWAYS_INLINE void _thread_monitor_init(struct tcs *tcs /* thread */
  *
  * <options> is currently unused.
  *
+ * @param pStackMem the aligned stack memory
+ * @param stackSize stack size in bytes
+ * @param pEntry the entry point
+ * @param parameter1 entry point to the first param
+ * @param parameter2 entry point to the second param
+ * @param parameter3 entry point to the third param
+ * @param priority thread priority (-1 for tasks)
+ * @param misc options (future use)
+ *
  * @return N/A
  */
 
-void _new_thread(
-	char *pStackMem,      /* aligned stack memory */
-	unsigned stackSize,   /* stack size in bytes */
-	_thread_entry_t pEntry, /* entry point */
-	void *parameter1,     /* entry point first param */
-	void *parameter2,     /* entry point second param */
-	void *parameter3,     /* entry point third param */
-	int priority,	 /* thread priority (-1 for tasks) */
-	unsigned options      /* misc options (future) */
-	)
+void _new_thread(char *pStackMem, unsigned stackSize, _thread_entry_t pEntry,
+		 void *parameter1, void *parameter2, void *parameter3,
+		 int priority, unsigned options)
 {
 	char *stackEnd = pStackMem + stackSize;
 	struct __esf *pInitCtx;