doxygen: add @brief and capitalize
Remove function name from comment and add @brief instead.
Also capitilize first letter.
Change-Id: Ib708b49bf02e5bc89b0066637a55874e659637e0
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
diff --git a/arch/arc/core/atomic.S b/arch/arc/core/atomic.S
index d587a02..daf675e 100644
--- a/arch/arc/core/atomic.S
+++ b/arch/arc/core/atomic.S
@@ -62,7 +62,7 @@
/**
*
- * atomic_clear - atomically clear a memory location
+ * @brief Atomically clear a memory location
*
* This routine atomically clears the contents of <target> and returns the old
* value that was in <target>.
@@ -85,7 +85,7 @@
/**
*
- * atomic_set - atomically set a memory location
+ * @brief Atomically set a memory location
*
* This routine atomically sets the contents of <target> to <value> and returns
* the old value that was in <target>.
@@ -113,7 +113,7 @@
/**
*
- * atomic_get - Get the value of a shared memory atomically
+ * @brief Get the value of a shared memory atomically
*
* This routine atomically retrieves the value in *target
*
@@ -132,7 +132,7 @@
/**
*
- * atomic_inc - atomically increment a memory location
+ * @brief Atomically increment a memory location
*
* This routine atomically increments the value in <target>. The operation is
* done using unsigned integer arithmetic. Various CPU architectures may impose
@@ -158,7 +158,7 @@
/**
*
- * atomic_add - atomically add a value to a memory location
+ * @brief Atomically add a value to a memory location
*
* This routine atomically adds the contents of <target> and <value>, placing
* the result in <target>. The operation is done using signed integer arithmetic.
@@ -193,7 +193,7 @@
/**
*
- * atomic_dec - atomically decrement a memory location
+ * @brief Atomically decrement a memory location
*
* This routine atomically decrements the value in <target>. The operation is
* done using unsigned integer arithmetic. Various CPU architectures may impose
@@ -219,7 +219,7 @@
/**
*
- * atomic_sub - atomically subtract a value from a memory location
+ * @brief Atomically subtract a value from a memory location
*
* This routine atomically subtracts <value> from the contents of <target>,
* placing the result in <target>. The operation is done using signed integer
@@ -255,7 +255,7 @@
/**
*
- * atomic_nand - atomically perform a bitwise NAND on a memory location
+ * @brief Atomically perform a bitwise NAND on a memory location
*
* This routine atomically performs a bitwise NAND operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -292,7 +292,7 @@
/**
*
- * atomic_and - atomically perform a bitwise AND on a memory location
+ * @brief Atomically perform a bitwise AND on a memory location
*
* This routine atomically performs a bitwise AND operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -328,7 +328,7 @@
/**
*
- * atomic_or - atomically perform a bitwise OR on memory location
+ * @brief Atomically perform a bitwise OR on memory location
*
* This routine atomically performs a bitwise OR operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -364,7 +364,7 @@
/**
*
- * atomic_xor - atomically perform a bitwise XOR on a memory location
+ * @brief Atomically perform a bitwise XOR on a memory location
*
* This routine atomically performs a bitwise XOR operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -400,7 +400,7 @@
/**
*
- * atomic_cas - atomically compare-and-swap the contents of a memory location
+ * @brief Atomically compare-and-swap the contents of a memory location
*
* This routine performs an atomic compare-and-swap. testing that the contents of
* <target> contains <oldValue>, and if it does, setting the value of <target>
diff --git a/arch/arc/core/context.c b/arch/arc/core/context.c
index 4cad5af..4f8c8cd 100644
--- a/arch/arc/core/context.c
+++ b/arch/arc/core/context.c
@@ -65,7 +65,7 @@
#if defined(CONFIG_CONTEXT_MONITOR)
/*
- * context_monitor_init - initialize context monitoring support
+ * @brief Initialize context monitoring support
*
* Currently only inserts the new context in the list of active contexts.
*
@@ -92,7 +92,7 @@
#endif /* CONFIG_CONTEXT_MONITOR */
/*
- * _NewContext - initialize a new context (thread) from its stack space
+ * @brief Initialize a new context (thread) from its stack space
*
* The control structure (CCS) is put at the lower address of the stack. An
* initial context, to be "restored" by __return_from_coop(), is put at
diff --git a/arch/arc/core/context_wrapper.S b/arch/arc/core/context_wrapper.S
index 3c379c6..3a6bed1 100644
--- a/arch/arc/core/context_wrapper.S
+++ b/arch/arc/core/context_wrapper.S
@@ -46,7 +46,7 @@
/*
- * _ContextEntryWrapper - wrapper for _context_entry
+ * @brief Wrapper for _context_entry
*
* The routine pops parameters for the _context_entry from
* stack frame, prepared by the _NewContext() routine
diff --git a/arch/arc/core/cpu_idle.S b/arch/arc/core/cpu_idle.S
index d11b768..2cd45cb 100644
--- a/arch/arc/core/cpu_idle.S
+++ b/arch/arc/core/cpu_idle.S
@@ -51,7 +51,7 @@
.word 0
/*
- * nano_cpu_idle - put the CPU in low-power mode
+ * @brief Put the CPU in low-power mode
*
* This function always exits with interrupts unlocked.
*
@@ -65,7 +65,7 @@
nop
/*
- * nano_cpu_atomic_idle - put the CPU in low-power mode, entered with IRQs locked
+ * @brief Put the CPU in low-power mode, entered with IRQs locked
*
* This function exits with interrupts restored to <key>.
*
diff --git a/arch/arc/core/fast_irq.S b/arch/arc/core/fast_irq.S
index ab80d53..9e43b70 100644
--- a/arch/arc/core/fast_irq.S
+++ b/arch/arc/core/fast_irq.S
@@ -55,7 +55,7 @@
/**
*
- * _firq_enter - work to be done before handing control to a FIRQ ISR
+ * @brief Work to be done before handing control to a FIRQ ISR
*
* The processor switches to a second register bank so registers from the
* current bank do not have to be preserved yet. The only issue is the LP_START/
@@ -99,7 +99,7 @@
/**
*
- * _firq_exit - work to be done exiting a FIRQ
+ * @brief Work to be done exiting a FIRQ
*
* @return N/A
*/
@@ -258,7 +258,7 @@
/**
*
- * _firq_stack_setup - install the FIRQ stack in register bank 1
+ * @brief Install the FIRQ stack in register bank 1
*
* @return N/A
*/
diff --git a/arch/arc/core/fatal.c b/arch/arc/core/fatal.c
index c951abf..52d19a8 100644
--- a/arch/arc/core/fatal.c
+++ b/arch/arc/core/fatal.c
@@ -54,7 +54,7 @@
/**
*
- * _NanoFatalErrorHandler - nanokernel fatal error handler
+ * @brief Nanokernel fatal error handler
*
* This routine is called when fatal error conditions are detected by software
* and is responsible only for reporting the error. Once reported, it then
diff --git a/arch/arc/core/fault.c b/arch/arc/core/fault.c
index 6125fca..60c17f1 100644
--- a/arch/arc/core/fault.c
+++ b/arch/arc/core/fault.c
@@ -60,7 +60,7 @@
#if (CONFIG_FAULT_DUMP > 0)
/*
- * _FaultDump - dump information regarding fault (FAULT_DUMP > 0)
+ * @brief Dump information regarding fault (FAULT_DUMP > 0)
*
* Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 1
* (short form).
@@ -85,7 +85,7 @@
#endif /* CONFIG_FAULT_DUMP */
/*
- * _Fault - fault handler
+ * @brief Fault handler
*
* This routine is called when fatal error conditions are detected by hardware
* and is responsible only for reporting the error. Once reported, it then
diff --git a/arch/arc/core/fault_s.S b/arch/arc/core/fault_s.S
index 9863f32..29c2daf 100644
--- a/arch/arc/core/fault_s.S
+++ b/arch/arc/core/fault_s.S
@@ -64,7 +64,7 @@
.word 0
/*
- * __fault - fault handler installed in the fault and reserved vectors
+ * @brief Fault handler installed in the fault and reserved vectors
*/
SECTION_SUBSEC_FUNC(TEXT,__fault,__memory_error)
diff --git a/arch/arc/core/ffs.S b/arch/arc/core/ffs.S
index 34260d8..fc55449 100644
--- a/arch/arc/core/ffs.S
+++ b/arch/arc/core/ffs.S
@@ -48,7 +48,7 @@
/**
*
- * nanoFfsMsb - find first set bit (searching from the most significant bit)
+ * @brief Find first set bit (searching from the most significant bit)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
@@ -71,7 +71,7 @@
/**
*
- * nanoFfsLsb - find first set bit (searching from the least significant bit)
+ * @brief Find first set bit (searching from the least significant bit)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
diff --git a/arch/arc/core/irq_lock.S b/arch/arc/core/irq_lock.S
index 1f5f8b0..fa40e5b 100644
--- a/arch/arc/core/irq_lock.S
+++ b/arch/arc/core/irq_lock.S
@@ -42,7 +42,7 @@
/**
*
- * irq_lock - disable all interrupts on the local CPU
+ * @brief Disable all interrupts on the local CPU
*
* This routine disables interrupts. It can be called from either interrupt,
* task or fiber level. This routine returns an architecture-dependent
@@ -77,7 +77,7 @@
/**
*
- * irq_unlock - enable all interrupts on the local CPU
+ * @brief Enable all interrupts on the local CPU
*
* This routine re-enables interrupts on the local CPU. The <key> parameter
* is an architecture-dependent lock-out key that is returned by a previous
diff --git a/arch/arc/core/irq_manage.c b/arch/arc/core/irq_manage.c
index e2304ac..13b231e 100644
--- a/arch/arc/core/irq_manage.c
+++ b/arch/arc/core/irq_manage.c
@@ -52,7 +52,7 @@
#include <sw_isr_table.h>
/*
- * irq_handler_set - replace an interrupt handler by another
+ * @brief Replace an interrupt handler by another
*
* An interrupt's ISR can be replaced at runtime. Care must be taken that the
* interrupt is disabled before doing this.
@@ -85,7 +85,7 @@
}
/*
- * irq_enable - enable an interrupt line
+ * @brief Enable an interrupt line
*
* Clear possible pending interrupts on the line, and enable the interrupt
* line. After this call, the CPU will receive interrupts for the specified
@@ -103,7 +103,7 @@
}
/*
- * irq_disable - disable an interrupt line
+ * @brief Disable an interrupt line
*
* Disable an interrupt line. After this call, the CPU will stop receiving
* interrupts for the specified <irq>.
@@ -120,7 +120,7 @@
}
/*
- * irq_priority_set - set an interrupt's priority
+ * @brief Set an interrupt's priority
*
* Valid values are from 0 to 15. Interrupts of priority 1 are not masked when
* interrupts are locked system-wide, so care must be taken when using them. ISR
@@ -145,7 +145,7 @@
}
/*
- * _irq_spurious - spurious interrupt handler
+ * @brief Spurious interrupt handler
*
* Installed in all dynamic interrupt slots at boot time. Throws an error if
* called.
@@ -163,7 +163,7 @@
}
/*
- * irq_connect - connect an ISR to an interrupt line
+ * @brief Connect an ISR to an interrupt line
*
* <isr> is connected to interrupt line <irq>, a number greater than or equal
* 16. No prior ISR can have been connected on <irq> interrupt line since the
@@ -188,7 +188,7 @@
}
/*
- * irq_disconnect - disconnect an ISR from an interrupt line
+ * @brief Disconnect an ISR from an interrupt line
*
* Interrupt line <irq> is disconnected from its ISR and the latter is
* replaced by _irq_spurious(). irq_disable() should have been called before
diff --git a/arch/arc/core/regular_irq.S b/arch/arc/core/regular_irq.S
index f178df1..ee1039d 100644
--- a/arch/arc/core/regular_irq.S
+++ b/arch/arc/core/regular_irq.S
@@ -51,7 +51,7 @@
/**
*
- * _rirq_enter - work to be done before handing control to an IRQ ISR
+ * @brief Work to be done before handing control to an IRQ ISR
*
* The processor pushes automatically all registers that need to be saved.
* However, since the processor always runs at kernel privilege there is no
@@ -77,7 +77,7 @@
/**
*
- * _rirq_exit - work to be done exiting an IRQ
+ * @brief Work to be done exiting an IRQ
*
* @return N/A
*/
diff --git a/arch/arc/core/swap.S b/arch/arc/core/swap.S
index aefdd90..51708ae 100644
--- a/arch/arc/core/swap.S
+++ b/arch/arc/core/swap.S
@@ -53,7 +53,7 @@
/**
*
- * _Swap - initiate a cooperative context switch
+ * @brief Initiate a cooperative context switch
*
* The _Swap() routine is invoked by various nanokernel services to effect
* a cooperative context context switch. Prior to invoking _Swap(), the caller
diff --git a/arch/arc/fatal_error.c b/arch/arc/fatal_error.c
index d427d28..b2ef099 100644
--- a/arch/arc/fatal_error.c
+++ b/arch/arc/fatal_error.c
@@ -63,7 +63,7 @@
/**
*
- * _SysFatalErrorHandler - fatal error handler
+ * @brief Fatal error handler
*
* This routine implements the corrective action to be taken when the system
* detects a fatal error.
diff --git a/arch/arc/include/nano_private.h b/arch/arc/include/nano_private.h
index c7806aa..b822966 100644
--- a/arch/arc/include/nano_private.h
+++ b/arch/arc/include/nano_private.h
@@ -240,7 +240,7 @@
/**
*
- * fiberRtnValueSet - set the return value for the specified fiber (inline)
+ * @brief Set the return value for the specified fiber (inline)
*
* The register used to store the return value from a function call invocation
* to <value>. It is assumed that the specified <fiber> is pending, and thus
@@ -258,7 +258,7 @@
/**
*
- * _IS_IN_ISR - indicates if kernel is handling interrupt
+ * @brief Indicates if kernel is handling interrupt
*
* @return 1 if interrupt handler is executed, 0 otherwise
*
diff --git a/arch/arc/include/v2/cache.h b/arch/arc/include/v2/cache.h
index b7167c2..6877786 100644
--- a/arch/arc/include/v2/cache.h
+++ b/arch/arc/include/v2/cache.h
@@ -49,7 +49,7 @@
#define CACHE_CACHE_CONTROLLED 0x20
/*
- * _icache_enable - sets the I-cache
+ * @brief Sets the I-cache
*
* Enables cache and sets the direct access.
*/
diff --git a/arch/arc/prep_c.c b/arch/arc/prep_c.c
index 03b99a3..1b55900 100644
--- a/arch/arc/prep_c.c
+++ b/arch/arc/prep_c.c
@@ -46,7 +46,7 @@
/**
*
- * bssZero - clear BSS
+ * @brief Clear BSS
*
* This routine clears the BSS region, so all bytes are 0.
*
@@ -65,7 +65,7 @@
/**
*
- * dataCopy - copy the data section from ROM to RAM
+ * @brief Copy the data section from ROM to RAM
*
* This routine copies the data section from ROM to RAM.
*
@@ -92,7 +92,7 @@
extern FUNC_NORETURN void _Cstart(void);
/**
*
- * _PrepC - prepare to and run C code
+ * @brief Prepare to and run C code
*
* This routine prepares for the execution of and runs C code.
*
diff --git a/arch/arc/reset.S b/arch/arc/reset.S
index 1748869..a6ae826 100644
--- a/arch/arc/reset.S
+++ b/arch/arc/reset.S
@@ -48,7 +48,7 @@
/**
*
- * __reset - reset vector
+ * @brief Reset vector
*
* Ran when the system comes out of reset. The processor is at supervisor level.
*
diff --git a/arch/arm/bsp/CortexM/nmi.c b/arch/arm/bsp/CortexM/nmi.c
index 36a9496..ebab58a 100644
--- a/arch/arm/bsp/CortexM/nmi.c
+++ b/arch/arm/bsp/CortexM/nmi.c
@@ -54,7 +54,7 @@
/**
*
- * _DefaultHandler - default NMI handler installed when kernel is up
+ * @brief Default NMI handler installed when kernel is up
*
* The default handler outputs a error message and reboots the target. It is
* installed by calling _NmiInit();
@@ -70,7 +70,7 @@
/**
*
- * _NmiInit - install default runtime NMI handler
+ * @brief Install default runtime NMI handler
*
* Meant to be called by BSP code if they want to install a simple NMI handler
* that reboots the target. It should be installed after the console is
@@ -86,7 +86,7 @@
/**
*
- * _NmiHandlerSet - install a custom runtime NMI handler
+ * @brief Install a custom runtime NMI handler
*
* Meant to be called by BSP code if they want to install a custom NMI handler
* that reboots. It should be installed after the console is initialized if it is
@@ -103,7 +103,7 @@
/**
*
- * __nmi - handler installed in the vector table
+ * @brief Handler installed in the vector table
*
* Simply call what is installed in 'static void(*handler)(void)'.
*
diff --git a/arch/arm/bsp/CortexM/prep_c.c b/arch/arm/bsp/CortexM/prep_c.c
index 6a5a673..65d3887 100644
--- a/arch/arm/bsp/CortexM/prep_c.c
+++ b/arch/arm/bsp/CortexM/prep_c.c
@@ -46,7 +46,7 @@
/**
*
- * bssZero - clear BSS
+ * @brief Clear BSS
*
* This routine clears the BSS region, so all bytes are 0.
*
@@ -65,7 +65,7 @@
/**
*
- * dataCopy - copy the data section from ROM to RAM
+ * @brief Copy the data section from ROM to RAM
*
* This routine copies the data section from ROM to RAM.
*
@@ -92,7 +92,7 @@
extern FUNC_NORETURN void _Cstart(void);
/**
*
- * _PrepC - prepare to and run C code
+ * @brief Prepare to and run C code
*
* This routine prepares for the execution of and runs C code.
*
diff --git a/arch/arm/bsp/CortexM/reset.S b/arch/arm/bsp/CortexM/reset.S
index fe5b55e..aaae497 100644
--- a/arch/arm/bsp/CortexM/reset.S
+++ b/arch/arm/bsp/CortexM/reset.S
@@ -49,7 +49,7 @@
/**
*
- * __reset - reset vector
+ * @brief Reset vector
*
* Ran when the system comes out of reset. The processor is in thread mode with
* privileged level. At this point, the main stack pointer (MSP) is already
diff --git a/arch/arm/bsp/CortexM/scb.c b/arch/arm/bsp/CortexM/scb.c
index 21aa0da..8deb9f3 100644
--- a/arch/arm/bsp/CortexM/scb.c
+++ b/arch/arm/bsp/CortexM/scb.c
@@ -46,7 +46,7 @@
/**
*
- * _ScbSystemReset - reset the system
+ * @brief Reset the system
*
* This routine resets the processor.
*
@@ -65,7 +65,7 @@
/**
*
- * _ScbNumPriGroupSet - set the number of priority groups based on the number
+ * @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
diff --git a/arch/arm/bsp/sysFatalErrorHandler.c b/arch/arm/bsp/sysFatalErrorHandler.c
index 7530dd4..75e1f01 100644
--- a/arch/arm/bsp/sysFatalErrorHandler.c
+++ b/arch/arm/bsp/sysFatalErrorHandler.c
@@ -63,7 +63,7 @@
/**
*
- * _SysFatalErrorHandler - fatal error handler
+ * @brief Fatal error handler
*
* This routine implements the corrective action to be taken when the system
* detects a fatal error.
diff --git a/arch/arm/core/atomic.S b/arch/arm/core/atomic.S
index 2376a53..0d290bb 100644
--- a/arch/arm/core/atomic.S
+++ b/arch/arm/core/atomic.S
@@ -61,7 +61,7 @@
/**
*
- * atomic_clear - atomically clear a memory location
+ * @brief Atomically clear a memory location
*
* This routine atomically clears the contents of <target> and returns the old
* value that was in <target>.
@@ -84,7 +84,7 @@
/**
*
- * atomic_set - atomically set a memory location
+ * @brief Atomically set a memory location
*
* This routine atomically sets the contents of <target> to <value> and returns
* the old value that was in <target>.
@@ -116,7 +116,7 @@
/**
*
- * atomic_get - Get the value of a shared memory atomically
+ * @brief Get the value of a shared memory atomically
*
* This routine atomically retrieves the value in *target
*
@@ -135,7 +135,7 @@
/**
*
- * atomic_inc - atomically increment a memory location
+ * @brief Atomically increment a memory location
*
* This routine atomically increments the value in <target>. The operation is
* done using unsigned integer arithmetic. Various CPU architectures may impose
@@ -161,7 +161,7 @@
/**
*
- * atomic_add - atomically add a value to a memory location
+ * @brief Atomically add a value to a memory location
*
* This routine atomically adds the contents of <target> and <value>, placing
* the result in <target>. The operation is done using signed integer arithmetic.
@@ -195,7 +195,7 @@
/**
*
- * atomic_dec - atomically decrement a memory location
+ * @brief Atomically decrement a memory location
*
* This routine atomically decrements the value in <target>. The operation is
* done using unsigned integer arithmetic. Various CPU architectures may impose
@@ -221,7 +221,7 @@
/**
*
- * atomic_sub - atomically subtract a value from a memory location
+ * @brief Atomically subtract a value from a memory location
*
* This routine atomically subtracts <value> from the contents of <target>,
* placing the result in <target>. The operation is done using signed integer
@@ -255,7 +255,7 @@
/**
*
- * atomic_nand - atomically perform a bitwise NAND on a memory location
+ * @brief Atomically perform a bitwise NAND on a memory location
*
* This routine atomically performs a bitwise NAND operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -290,7 +290,7 @@
/**
*
- * atomic_and - atomically perform a bitwise AND on a memory location
+ * @brief Atomically perform a bitwise AND on a memory location
*
* This routine atomically performs a bitwise AND operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -324,7 +324,7 @@
/**
*
- * atomic_or - atomically perform a bitwise OR on memory location
+ * @brief Atomically perform a bitwise OR on memory location
*
* This routine atomically performs a bitwise OR operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -358,7 +358,7 @@
/**
*
- * atomic_xor - atomically perform a bitwise XOR on a memory location
+ * @brief Atomically perform a bitwise XOR on a memory location
*
* This routine atomically performs a bitwise XOR operation of the contents of
* <target> and <value>, placing the result in <target>.
@@ -392,7 +392,7 @@
/**
*
- * atomic_cas - atomically compare-and-swap the contents of a memory location
+ * @brief Atomically compare-and-swap the contents of a memory location
*
* This routine performs an atomic compare-and-swap. testing that the contents of
* <target> contains <oldValue>, and if it does, setting the value of <target>
diff --git a/arch/arm/core/basepri.S b/arch/arm/core/basepri.S
index 68ae171..5fe6c6b 100644
--- a/arch/arm/core/basepri.S
+++ b/arch/arm/core/basepri.S
@@ -61,7 +61,7 @@
/**
*
- * irq_lock - lock interrupts
+ * @brief Lock interrupts
*
* Prevent exceptions of priority lower than to the two highest priorities from
* interrupting the CPU.
@@ -80,7 +80,7 @@
/**
*
- * irq_unlock - unlock interrupts
+ * @brief Unlock interrupts
*
* Return the state of interrupt locking to a previous level, passed in via the
* <key> parameter, obtained from a previous call to irq_lock().
diff --git a/arch/arm/core/context.c b/arch/arm/core/context.c
index b7ed5fc..2b48c65 100644
--- a/arch/arm/core/context.c
+++ b/arch/arm/core/context.c
@@ -55,7 +55,7 @@
#if defined(CONFIG_CONTEXT_MONITOR)
/**
*
- * _context_monitor_init - initialize context monitoring support
+ * @brief Initialize context monitoring support
*
* Currently only inserts the new context in the list of active contexts.
*
@@ -83,7 +83,7 @@
/**
*
- * _NewContext - intialize a new context (thread) from its stack space
+ * @brief Intialize a new context (thread) from its stack space
*
* The control structure (CCS) is put at the lower address of the stack. An
* initial context, to be "restored" by __pendsv(), is put at the other end of
diff --git a/arch/arm/core/cpu_idle.S b/arch/arm/core/cpu_idle.S
index 6e2146b..3cf5fdc 100644
--- a/arch/arm/core/cpu_idle.S
+++ b/arch/arm/core/cpu_idle.S
@@ -58,7 +58,7 @@
/**
*
- * _CpuIdleInit - initialization of CPU idle
+ * @brief Initialization of CPU idle
*
* Only called by nanoArchInit(). Sets SEVONPEND bit once for the system's
* duration.
@@ -80,7 +80,7 @@
/**
*
- * _NanoIdleValGet - get the kernel idle setting
+ * @brief Get the kernel idle setting
*
* Returns the nanokernel idle setting, in ticks. Only called by __systick().
*
@@ -98,7 +98,7 @@
/**
*
- * _NanoIdleValClear - clear the kernel idle setting
+ * @brief Clear the kernel idle setting
*
* Sets the nanokernel idle setting to 0. Only called by __systick().
*
@@ -119,7 +119,7 @@
/**
*
- * nano_cpu_idle - power save idle routine for ARM Cortex-M
+ * @brief Power save idle routine for ARM Cortex-M
*
* This function will be called by the nanokernel idle loop or possibly within
* an implementation of _sys_power_save_idle in the microkernel when the
@@ -144,7 +144,7 @@
/**
*
- * nano_cpu_atomic_idle - atomically re-enable interrupts and enter low power mode
+ * @brief Atomically re-enable interrupts and enter low power mode
*
* This function is utilized by the nanokernel object "wait" APIs for task
* contexts, e.g. nano_task_lifo_get_wait(), nano_task_sem_take_wait(), nano_task_stack_pop_wait(),
diff --git a/arch/arm/core/exc_exit.S b/arch/arm/core/exc_exit.S
index aef35b3..f28fc27 100644
--- a/arch/arm/core/exc_exit.S
+++ b/arch/arm/core/exc_exit.S
@@ -63,7 +63,7 @@
/**
*
- * _IntExit - kernel housekeeping when exiting interrupt handler installed
+ * @brief Kernel housekeeping when exiting interrupt handler installed
* directly in vector table
*
* Kernel allows installing interrupt handlers (ISRs) directly into the vector
@@ -94,7 +94,7 @@
/**
*
- * _ExcExit - kernel housekeeping when exiting exception handler installed
+ * @brief Kernel housekeeping when exiting exception handler installed
* directly in vector table
*
* See _IntExit().
diff --git a/arch/arm/core/fatal.c b/arch/arm/core/fatal.c
index d57e944..99a872b 100644
--- a/arch/arm/core/fatal.c
+++ b/arch/arm/core/fatal.c
@@ -64,7 +64,7 @@
/**
*
- * _NanoFatalErrorHandler - nanokernel fatal error handler
+ * @brief Nanokernel fatal error handler
*
* This routine is called when fatal error conditions are detected by software
* and is responsible only for reporting the error. Once reported, it then
diff --git a/arch/arm/core/fault.c b/arch/arm/core/fault.c
index 92feff8..b7b6090 100644
--- a/arch/arm/core/fault.c
+++ b/arch/arm/core/fault.c
@@ -61,7 +61,7 @@
#if (CONFIG_FAULT_DUMP == 1)
/**
*
- * _FaultDump - dump information regarding fault (FAULT_DUMP == 1)
+ * @brief Dump information regarding fault (FAULT_DUMP == 1)
*
* Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 1
* (short form).
@@ -120,7 +120,7 @@
#if (CONFIG_FAULT_DUMP == 2)
/**
*
- * _FaultContextShow - dump context information
+ * @brief Dump context information
*
* See _FaultDump() for example.
*
@@ -139,7 +139,7 @@
/**
*
- * _MpuFault - dump MPU fault information
+ * @brief Dump MPU fault information
*
* See _FaultDump() for example.
*
@@ -174,7 +174,7 @@
/**
*
- * _BusFault - dump bus fault information
+ * @brief Dump bus fault information
*
* See _FaultDump() for example.
*
@@ -215,7 +215,7 @@
/**
*
- * _UsageFault - dump usage fault information
+ * @brief Dump usage fault information
*
* See _FaultDump() for example.
*
@@ -255,7 +255,7 @@
/**
*
- * _HardFault - dump hard fault information
+ * @brief Dump hard fault information
*
* See _FaultDump() for example.
*
@@ -283,7 +283,7 @@
/**
*
- * _DebugMonitor - dump debug monitor exception information
+ * @brief Dump debug monitor exception information
*
* See _FaultDump() for example.
*
@@ -299,7 +299,7 @@
/**
*
- * _ReservedException - dump reserved exception information
+ * @brief Dump reserved exception information
*
* See _FaultDump() for example.
*
@@ -318,7 +318,7 @@
/**
*
- * _FaultDump - dump information regarding fault (FAULT_DUMP == 2)
+ * @brief Dump information regarding fault (FAULT_DUMP == 2)
*
* Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 2
* (long form).
@@ -365,7 +365,7 @@
/**
*
- * _Fault - fault handler
+ * @brief Fault handler
*
* This routine is called when fatal error conditions are detected by hardware
* and is responsible only for reporting the error. Once reported, it then
@@ -396,7 +396,7 @@
/**
*
- * _FaultInit - initialization of fault handling
+ * @brief Initialization of fault handling
*
* Turns on the desired hardware faults.
*
diff --git a/arch/arm/core/fault_s.S b/arch/arm/core/fault_s.S
index ab67aa5..3fb5cc5 100644
--- a/arch/arm/core/fault_s.S
+++ b/arch/arm/core/fault_s.S
@@ -54,7 +54,7 @@
/**
*
- * __fault - fault handler installed in the fault and reserved vectors
+ * @brief Fault handler installed in the fault and reserved vectors
*
* Entry point for the hard fault, MPU fault, bus fault, usage fault, debug
* monitor and reserved exceptions.
diff --git a/arch/arm/core/ffs.S b/arch/arm/core/ffs.S
index 72289bf..6111848 100644
--- a/arch/arm/core/ffs.S
+++ b/arch/arm/core/ffs.S
@@ -50,7 +50,7 @@
/**
*
- * find_last_set - find first set bit (searching from the most significant bit)
+ * @brief Find first set bit (searching from the most significant bit)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
@@ -71,7 +71,7 @@
/**
*
- * find_first_set - find first set bit (searching from the least significant bit)
+ * @brief Find first set bit (searching from the least significant bit)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
diff --git a/arch/arm/core/fiber_abort.c b/arch/arm/core/fiber_abort.c
index 93b148c..9cfcb33 100644
--- a/arch/arm/core/fiber_abort.c
+++ b/arch/arm/core/fiber_abort.c
@@ -53,7 +53,7 @@
/**
*
- * fiber_abort - abort the currently executing fiber
+ * @brief Abort the currently executing fiber
*
* Possible reasons for a fiber aborting:
*
diff --git a/arch/arm/core/gdb_stub.S b/arch/arm/core/gdb_stub.S
index 03b8ee6..56e2d4b 100644
--- a/arch/arm/core/gdb_stub.S
+++ b/arch/arm/core/gdb_stub.S
@@ -53,7 +53,7 @@
/**
*
- * _GdbStubExcEntry - exception entry extra work when GDB_INFO is enabled
+ * @brief Exception entry extra work when GDB_INFO is enabled
*
* During normal system operation, the callee-saved registers are saved lazily
* only when a context switch is required. To allow looking at the current
@@ -97,7 +97,7 @@
/**
*
- * _GdbStubExcExit - exception exit extra clean up when GDB_INFO is enabled
+ * @brief Exception exit extra clean up when GDB_INFO is enabled
*
* Record the fact that the thread is not interrupted anymore so that VQEMU
* looks at the CPU registers and not into the CCS to obtain the current
@@ -131,8 +131,7 @@
/**
*
- * _irq_vector_table_entry_with_gdb_stub - stub for ISRs installed directly in
- * vector table
+ * @brief Stub for ISRs installed directly in vector table
*
* The kernel on Cortex-M3/4 can be configured so that ISRs
* are installed directly in the vector table for maximum efficiency.
diff --git a/arch/arm/core/irq_init.c b/arch/arm/core/irq_init.c
index 3cf367b..d39e5b4 100644
--- a/arch/arm/core/irq_init.c
+++ b/arch/arm/core/irq_init.c
@@ -47,7 +47,7 @@
/**
*
- * _IntLibInit - initialize interrupts
+ * @brief Initialize interrupts
*
* Ensures all interrupts have their priority set to _EXC_IRQ_DEFAULT_PRIO and
* not 0, which they have it set to when coming out of reset. This ensures that
diff --git a/arch/arm/core/irq_manage.c b/arch/arm/core/irq_manage.c
index 6a1a433..088a59d 100644
--- a/arch/arm/core/irq_manage.c
+++ b/arch/arm/core/irq_manage.c
@@ -48,7 +48,7 @@
/**
*
- * irq_handler_set - replace an interrupt handler by another
+ * @brief Replace an interrupt handler by another
*
* An interrupt's ISR can be replaced at runtime. Care must be taken that the
* interrupt is disabled before doing this.
@@ -78,7 +78,7 @@
/**
*
- * irq_enable - enable an interrupt line
+ * @brief Enable an interrupt line
*
* Clear possible pending interrupts on the line, and enable the interrupt
* line. After this call, the CPU will receive interrupts for the specified
@@ -96,7 +96,7 @@
/**
*
- * irq_disable - disable an interrupt line
+ * @brief Disable an interrupt line
*
* Disable an interrupt line. After this call, the CPU will stop receiving
* interrupts for the specified <irq>.
@@ -111,7 +111,7 @@
/**
*
- * irq_priority_set - set an interrupt's priority
+ * @brief Set an interrupt's priority
*
* Valid values are from 1 to 255. Interrupts of priority 1 are not masked when
* interrupts are locked system-wide, so care must be taken when using them. ISR
@@ -133,7 +133,7 @@
/**
*
- * _irq_spurious - spurious interrupt handler
+ * @brief Spurious interrupt handler
*
* Installed in all dynamic interrupt slots at boot time. Throws an error if
* called.
@@ -151,7 +151,7 @@
/**
*
- * irq_connect - connect an ISR to an interrupt line
+ * @brief Connect an ISR to an interrupt line
*
* <isr> is connected to interrupt line <irq> (exception #<irq>+16). No prior
* ISR can have been connected on <irq> interrupt line since the system booted.
@@ -174,7 +174,7 @@
/**
*
- * irq_disconnect - disconnect an ISR from an interrupt line
+ * @brief Disconnect an ISR from an interrupt line
*
* Interrupt line <irq> (exception #<irq>+16) is disconnected from its ISR and
* the latter is replaced by _irq_spurious(). irq_disable() should have
diff --git a/arch/arm/core/isr_wrapper.S b/arch/arm/core/isr_wrapper.S
index b93935a..f7fd7b5 100644
--- a/arch/arm/core/isr_wrapper.S
+++ b/arch/arm/core/isr_wrapper.S
@@ -55,7 +55,7 @@
/**
*
- * _isr_wrapper - wrapper around ISRs when inserted in software ISR table
+ * @brief Wrapper around ISRs when inserted in software ISR table
*
* When inserted in the vector table, _isr_wrapper() demuxes the ISR table using
* the running interrupt number as the index, and invokes the registered ISR
diff --git a/arch/arm/core/swap.S b/arch/arm/core/swap.S
index 0797012..0e296c5 100644
--- a/arch/arm/core/swap.S
+++ b/arch/arm/core/swap.S
@@ -53,7 +53,7 @@
/**
*
- * __pendsv - PendSV exception handler, handling context switches
+ * @brief PendSV exception handler, handling context switches
*
* The PendSV exception is the only context in the system that can perform
* context switching. When an execution context finds out it has to switch
@@ -148,7 +148,7 @@
/**
*
- * __svc - service call handler
+ * @brief Service call handler
*
* The service call (svc) is only used in _Swap() to enter handler mode so we
* can go through the PendSV exception to perform a context switch.
@@ -180,7 +180,7 @@
/**
*
- * _Swap - initiate a cooperative context switch
+ * @brief Initiate a cooperative context switch
*
* The _Swap() routine is invoked by various nanokernel services to effect
* a cooperative context context switch. Prior to invoking _Swap(), the caller
diff --git a/arch/arm/core/task_abort.c b/arch/arm/core/task_abort.c
index 251d1ee..c0c3f6d 100644
--- a/arch/arm/core/task_abort.c
+++ b/arch/arm/core/task_abort.c
@@ -54,7 +54,7 @@
/**
*
- * _TaskAbort - abort the current task
+ * @brief Abort the current task
*
* Possible reasons for a task aborting:
*
diff --git a/arch/arm/fsl_frdm_k64f/system.c b/arch/arm/fsl_frdm_k64f/system.c
index be91ab6..6f43ec6 100644
--- a/arch/arm/fsl_frdm_k64f/system.c
+++ b/arch/arm/fsl_frdm_k64f/system.c
@@ -96,7 +96,7 @@
/**
*
- * clkInit - initialize the system clock
+ * @brief Initialize the system clock
*
* This routine will configure the multipurpose clock generator (MCG) to
* set up the system clock.
@@ -249,7 +249,7 @@
/**
*
- * consoleInit - initialize target-only console
+ * @brief Initialize target-only console
*
* Only used for debugging.
*
@@ -300,7 +300,7 @@
/**
*
- * _InitHardware - perform basic hardware initialization
+ * @brief Perform basic hardware initialization
*
* Initialize the interrupt controller device drivers and the
* Kinetis UART device driver.
diff --git a/arch/arm/fsl_frdm_k64f/wdog.S b/arch/arm/fsl_frdm_k64f/wdog.S
index 2dad1dd..952a8ec 100644
--- a/arch/arm/fsl_frdm_k64f/wdog.S
+++ b/arch/arm/fsl_frdm_k64f/wdog.S
@@ -55,7 +55,7 @@
/**
*
- * _WdogInit - Watchdog timer disable routine
+ * @brief Watchdog timer disable routine
*
* This routine will disable the watchdog timer.
*
diff --git a/arch/arm/include/CortexM/asm_inline_gcc.h b/arch/arm/include/CortexM/asm_inline_gcc.h
index 2191d2a..9faa341 100644
--- a/arch/arm/include/CortexM/asm_inline_gcc.h
+++ b/arch/arm/include/CortexM/asm_inline_gcc.h
@@ -42,7 +42,7 @@
/**
*
- * _IpsrGet - obtain value of IPSR register
+ * @brief Obtain value of IPSR register
*
* Obtain and return current value of IPSR register.
*
@@ -61,7 +61,7 @@
/**
*
- * _MspSet - set the value of the Main Stack Pointer register
+ * @brief Set the value of the Main Stack Pointer register
*
* Store the value of <msp> in MSP register.
*
diff --git a/arch/arm/include/CortexM/exc.h b/arch/arm/include/CortexM/exc.h
index fd150c7..4fc5f8e 100644
--- a/arch/arm/include/CortexM/exc.h
+++ b/arch/arm/include/CortexM/exc.h
@@ -49,7 +49,7 @@
/**
*
- * _IsInIsr - find out if running in an ISR context
+ * @brief Find out if running in an ISR context
*
* The current executing vector is found in the IPSR register. We consider the
* IRQs (exception 16 and up), and the PendSV and SYSTICK exceptions, to be
@@ -69,7 +69,7 @@
}
/**
- * _ExcSetup - setup system exceptions
+ * @brief Setup system exceptions
*
* Set exception priorities to conform with the BASEPRI locking mechanism.
* Set PendSV priority to lowest possible.
diff --git a/arch/arm/include/CortexM/stack.h b/arch/arm/include/CortexM/stack.h
index 8d8ef8c..e5af104 100644
--- a/arch/arm/include/CortexM/stack.h
+++ b/arch/arm/include/CortexM/stack.h
@@ -70,7 +70,7 @@
/**
*
- * _InterruptStackSetup - setup interrupt stack
+ * @brief Setup interrupt stack
*
* On Cortex-M, the interrupt stack is registered in the MSP (main stack
* pointer) register, and switched to automatically when taking an exception.
diff --git a/arch/arm/include/nano_private.h b/arch/arm/include/nano_private.h
index 8a3876b..af086ea 100644
--- a/arch/arm/include/nano_private.h
+++ b/arch/arm/include/nano_private.h
@@ -186,7 +186,7 @@
/**
*
- * fiberRtnValueSet - set the return value for the specified fiber (inline)
+ * @brief Set the return value for the specified fiber (inline)
*
* The register used to store the return value from a function call invocation
* to <value>. It is assumed that the specified <fiber> is pending, and thus
diff --git a/arch/arm/ti_lm3s6965/scp.c b/arch/arm/ti_lm3s6965/scp.c
index 1a135aa..dfe1aae 100644
--- a/arch/arm/ti_lm3s6965/scp.c
+++ b/arch/arm/ti_lm3s6965/scp.c
@@ -51,7 +51,7 @@
/**
*
- * _ScpMainOscEnable - enable main oscillator with default frequency of 6MHz
+ * @brief Enable main oscillator with default frequency of 6MHz
*
* @return N/A
*/
diff --git a/arch/arm/ti_lm3s6965/system.c b/arch/arm/ti_lm3s6965/system.c
index cd5819c..7b996e3 100644
--- a/arch/arm/ti_lm3s6965/system.c
+++ b/arch/arm/ti_lm3s6965/system.c
@@ -61,7 +61,7 @@
/**
*
- * uart_generic_info_init - initialize generic information for one UART
+ * @brief Initialize generic information for one UART
*
* @return N/A
*
@@ -81,7 +81,7 @@
/**
*
- * consoleInit - initialize target-only console
+ * @brief Initialize target-only console
*
* Only used for debugging.
*
@@ -134,7 +134,7 @@
/**
*
- * _InitHardware - perform basic hardware initialization
+ * @brief Perform basic hardware initialization
*
* Initialize the interrupt controller device drivers and the
* integrated 16550-compatible UART device driver.
diff --git a/arch/x86/cache.c b/arch/x86/cache.c
index 7a932c7..f4971b1 100644
--- a/arch/x86/cache.c
+++ b/arch/x86/cache.c
@@ -46,7 +46,7 @@
/**
*
- * _SysCacheFlush - flush a page to main memory
+ * @brief Flush a page to main memory
*
* No alignment is required for either <virt> or <size>, but since
* _SysCacheFlush() iterates on the cache lines, a cache line alignment for both
diff --git a/arch/x86/cache_s.S b/arch/x86/cache_s.S
index 770072e..cee55c2 100644
--- a/arch/x86/cache_s.S
+++ b/arch/x86/cache_s.S
@@ -44,7 +44,7 @@
/**
*
- * _SysCacheFlush - flush a page to main memory
+ * @brief Flush a page to main memory
*
* This implementation flushes the whole cache.
*
diff --git a/arch/x86/core/atomic.S b/arch/x86/core/atomic.S
index 560a31c..ae20617 100644
--- a/arch/x86/core/atomic.S
+++ b/arch/x86/core/atomic.S
@@ -68,7 +68,7 @@
/**
*
- * atomic_cas - atomic compare-and-set primitive
+ * @brief Atomic compare-and-set primitive
*
* This routine provides the compare-and-set operator. If the original value at
* <target> equals <oldValue>, then <newValue> is stored at <target> and the
@@ -115,7 +115,7 @@
/**
*
- * atomic_add - atomic add primitive
+ * @brief Atomic add primitive
*
* This routine provides the atomic addition operator. The <value> is
* atomically added to the value at <target>, placing the result at <target>,
@@ -147,7 +147,7 @@
/**
*
- * atomic_sub - atomic subtraction primitive
+ * @brief Atomic subtraction primitive
*
* This routine provides the atomic subtraction operator. The <value> is
* atomically subtracted from the value at <target>, placing the result at
@@ -180,7 +180,7 @@
/**
*
- * atomic_inc - atomic increment primitive
+ * @brief Atomic increment primitive
*
* This routine provides the atomic increment operator. The value at <target>
* is atomically incremented by 1, and the old value from <target> is returned.
@@ -212,7 +212,7 @@
/**
*
- * atomic_dec - atomic decrement primitive
+ * @brief Atomic decrement primitive
*
* This routine provides the atomic decrement operator. The value at <target>
* is atomically decremented by 1, and the old value from <target> is returned.
@@ -242,7 +242,7 @@
/**
*
- * atomic_get - atomic get primitive
+ * @brief Atomic get primitive
*
* This routine provides the atomic get primitive to atomically read
* a value from <target>. It simply does an ordinary load. Note that <target>
@@ -266,7 +266,7 @@
/**
*
- * atomic_set - atomic get-and-set primitive
+ * @brief Atomic get-and-set primitive
*
* This routine provides the atomic set operator. The <value> is atomically
* written at <target> and the previous value at <target> is returned.
@@ -306,7 +306,7 @@
/**
*
- * atomic_clear - atomic clear primitive
+ * @brief Atomic clear primitive
*
* This routine provides the atomic clear operator. The value of 0 is atomically
* written at <target> and the previous value at <target> is returned. (Hence,
@@ -343,7 +343,7 @@
/**
*
- * atomic_or - atomic bitwise inclusive OR primitive
+ * @brief Atomic bitwise inclusive OR primitive
*
* This routine provides the atomic bitwise inclusive OR operator. The <value>
* is atomically bitwise OR'ed with the value at <target>, placing the result
@@ -381,7 +381,7 @@
/**
*
- * atomic_xor - atomic bitwise exclusive OR (XOR) primitive
+ * @brief Atomic bitwise exclusive OR (XOR) primitive
*
* This routine provides the atomic bitwise exclusive OR operator. The <value>
* is atomically bitwise XOR'ed with the value at <target>, placing the result
@@ -419,7 +419,7 @@
/**
*
- * atomic_and - atomic bitwise AND primitive
+ * @brief Atomic bitwise AND primitive
*
* This routine provides the atomic bitwise AND operator. The <value> is
* atomically bitwise AND'ed with the value at <target>, placing the result
@@ -457,7 +457,7 @@
/**
*
- * atomic_nand - atomic bitwise NAND primitive
+ * @brief Atomic bitwise NAND primitive
*
* This routine provides the atomic bitwise NAND operator. The <value> is
* atomically bitwise NAND'ed with the value at <target>, placing the result
diff --git a/arch/x86/core/atomic_nolock.c b/arch/x86/core/atomic_nolock.c
index 441167e..f3605d6 100644
--- a/arch/x86/core/atomic_nolock.c
+++ b/arch/x86/core/atomic_nolock.c
@@ -52,7 +52,7 @@
/**
*
- * atomic_cas - atomic compare-and-set primitive
+ * @brief Atomic compare-and-set primitive
*
* This routine provides the compare-and-set operator. If the original value at
* <target> equals <oldValue>, then <newValue> is stored at <target> and the
@@ -90,7 +90,7 @@
/**
*
- * atomic_add - atomic addition primitive
+ * @brief Atomic addition primitive
*
* This routine provides the atomic addition operator. The <value> is
* atomically added to the value at <target>, placing the result at <target>,
@@ -116,7 +116,7 @@
/**
*
- * atomic_sub - atomic subtraction primitive
+ * @brief Atomic subtraction primitive
*
* This routine provides the atomic subtraction operator. The <value> is
* atomically subtracted from the value at <target>, placing the result at
@@ -142,7 +142,7 @@
/**
*
- * atomic_inc - atomic increment primitive
+ * @brief Atomic increment primitive
*
* This routine provides the atomic increment operator. The value at <target>
* is atomically incremented by 1, and the old value from <target> is returned.
@@ -166,7 +166,7 @@
/**
*
- * atomic_dec - atomic decrement primitive
+ * @brief Atomic decrement primitive
*
* This routine provides the atomic decrement operator. The value at <target>
* is atomically decremented by 1, and the old value from <target> is returned.
@@ -190,7 +190,7 @@
/**
*
- * atomic_get - atomic get primitive
+ * @brief Atomic get primitive
*
* This routine provides the atomic get primitive to atomically read
* a value from <target>. It simply does an ordinary load. Note that <target>
@@ -207,7 +207,7 @@
/**
*
- * atomic_set - atomic get-and-set primitive
+ * @brief Atomic get-and-set primitive
*
* This routine provides the atomic set operator. The <value> is atomically
* written at <target> and the previous value at <target> is returned.
@@ -232,7 +232,7 @@
/**
*
- * atomic_clear - atomic clear primitive
+ * @brief Atomic clear primitive
*
* This routine provides the atomic clear operator. The value of 0 is atomically
* written at <target> and the previous value at <target> is returned. (Hence,
@@ -257,7 +257,7 @@
/**
*
- * atomic_or - atomic bitwise inclusive OR primitive
+ * @brief Atomic bitwise inclusive OR primitive
*
* This routine provides the atomic bitwise inclusive OR operator. The <value>
* is atomically bitwise OR'ed with the value at <target>, placing the result
@@ -283,7 +283,7 @@
/**
*
- * atomic_xor - atomic bitwise exclusive OR (XOR) primitive
+ * @brief Atomic bitwise exclusive OR (XOR) primitive
*
* This routine provides the atomic bitwise exclusive OR operator. The <value>
* is atomically bitwise XOR'ed with the value at <target>, placing the result
@@ -309,7 +309,7 @@
/**
*
- * atomic_and - atomic bitwise AND primitive
+ * @brief Atomic bitwise AND primitive
*
* This routine provides the atomic bitwise AND operator. The <value> is
* atomically bitwise AND'ed with the value at <target>, placing the result
@@ -335,7 +335,7 @@
/**
*
- * atomic_nand - atomic bitwise NAND primitive
+ * @brief Atomic bitwise NAND primitive
*
* This routine provides the atomic bitwise NAND operator. The <value> is
* atomically bitwise NAND'ed with the value at <target>, placing the result
diff --git a/arch/x86/core/context.c b/arch/x86/core/context.c
index a1b4d35..4aa1be5 100644
--- a/arch/x86/core/context.c
+++ b/arch/x86/core/context.c
@@ -59,7 +59,7 @@
/**
*
- * _NewContextInternal - initialize a new execution context
+ * @brief Initialize a new execution context
*
* This function is utilized to initialize all execution contexts (both fiber
* and task). The 'priority' parameter will be set to -1 for the creation of
@@ -208,7 +208,7 @@
#ifdef CONFIG_GDB_INFO
/**
*
- * _ContextEntryWrapper - adjust stack before invoking _context_entry
+ * @brief Adjust stack before invoking _context_entry
*
* This function adjusts the initial stack frame created by _NewContext()
* such that the GDB stack frame unwinders recognize it as the outermost frame
@@ -275,7 +275,7 @@
/**
*
- * _NewContext - create a new kernel execution context
+ * @brief Create a new kernel execution context
*
* This function is utilized to create execution contexts for both fiber
* contexts and kernel task contexts.
diff --git a/arch/x86/core/cpuhalt.S b/arch/x86/core/cpuhalt.S
index fcd23a9..3405eab 100644
--- a/arch/x86/core/cpuhalt.S
+++ b/arch/x86/core/cpuhalt.S
@@ -66,7 +66,7 @@
/**
*
- * nano_cpu_idle - power save idle routine for IA-32
+ * @brief Power save idle routine for IA-32
*
* This function will be called by the nanokernel idle loop or possibly within
* an implementation of _sys_power_save_idle in the microkernel when the
@@ -96,7 +96,7 @@
/**
*
- * nano_cpu_atomic_idle - atomically re-enable interrupts and enter low power mode
+ * @brief Atomically re-enable interrupts and enter low power mode
*
* This function is utilized by the nanokernel object "wait" APIs for task
* contexts, e.g. nano_task_lifo_get_wait(), nano_task_sem_take_wait(), nano_task_stack_pop_wait(),
diff --git a/arch/x86/core/excconnect.c b/arch/x86/core/excconnect.c
index 1bb9bf3..b63eb96 100644
--- a/arch/x86/core/excconnect.c
+++ b/arch/x86/core/excconnect.c
@@ -88,7 +88,7 @@
/**
*
- * nanoCpuExcConnect - connect a C routine to an exception
+ * @brief Connect a C routine to an exception
*
* This routine connects an exception handler coded in C to the specified
* interrupt vector. An exception is defined as a synchronous interrupt, i.e.
@@ -128,7 +128,7 @@
/**
*
- * _NanoCpuExcConnectAtDpl - connect a C routine to an exception
+ * @brief Connect a C routine to an exception
*
* This routine connects an exception handler coded in C to the specified
* interrupt vector. An exception is defined as a synchronous interrupt, i.e.
diff --git a/arch/x86/core/excstub.S b/arch/x86/core/excstub.S
index 4255d45..aad74c3 100644
--- a/arch/x86/core/excstub.S
+++ b/arch/x86/core/excstub.S
@@ -59,7 +59,7 @@
/**
*
- * _ExcEnt - inform the kernel of an exception
+ * @brief Inform the kernel of an exception
*
* This function is called from the exception stub created by nanoCpuExcConnect()
* to inform the kernel of an exception. This routine currently does
@@ -217,7 +217,7 @@
/**
*
- * _ExcExit - inform the kernel of an exception exit
+ * @brief Inform the kernel of an exception exit
*
* This function is called from the exception stub created by nanoCpuExcConnect()
* to inform the kernel that the processing of an exception has
diff --git a/arch/x86/core/fatal.c b/arch/x86/core/fatal.c
index b2ed06a..23196fa 100644
--- a/arch/x86/core/fatal.c
+++ b/arch/x86/core/fatal.c
@@ -67,7 +67,7 @@
/**
*
- * _NanoFatalErrorHandler - nanokernel fatal error handler
+ * @brief Nanokernel fatal error handler
*
* This routine is called when a fatal error condition is detected by either
* hardware or software.
diff --git a/arch/x86/core/ffs.S b/arch/x86/core/ffs.S
index 6cf16bd..9cf9884 100644
--- a/arch/x86/core/ffs.S
+++ b/arch/x86/core/ffs.S
@@ -53,7 +53,7 @@
/**
*
- * find_first_set - find first set bit searching from the LSB
+ * @brief Find first set bit searching from the LSB
*
* This routine finds the first bit set in the passed argument and
* returns the index of that bit. Bits are numbered starting
@@ -96,7 +96,7 @@
/**
*
- * find_last_set - find first set bit searching from the MSB
+ * @brief Find first set bit searching from the MSB
*
* This routine finds the first bit set in the passed argument and
* returns the index of that bit. Bits are numbered starting
diff --git a/arch/x86/core/float.c b/arch/x86/core/float.c
index 3f0c32e..5c7f6a5 100644
--- a/arch/x86/core/float.c
+++ b/arch/x86/core/float.c
@@ -114,7 +114,7 @@
/**
*
- * _FpCtxSave - save non-integer context information
+ * @brief Save non-integer context information
*
* This routine saves the system's "live" non-integer context into the
* specified CCS. If the specified task or fiber supports SSE then
@@ -130,7 +130,7 @@
/**
*
- * _FpCtxInit - initialize non-integer context information
+ * @brief Initialize non-integer context information
*
* This routine initializes the system's "live" non-integer context.
*
@@ -144,7 +144,7 @@
/**
*
- * _FpEnable - enable preservation of non-integer context information
+ * @brief Enable preservation of non-integer context information
*
* This routine allows the specified task/fiber (which may be the active
* task/fiber) to safely share the system's floating point registers with
@@ -289,7 +289,7 @@
/**
*
- * fiber_float_enable - enable preservation of non-integer context information
+ * @brief Enable preservation of non-integer context information
*
* This routine allows a fiber to permit a task/fiber (including itself) to
* safely share the system's floating point registers with other tasks/fibers.
@@ -303,7 +303,7 @@
/**
*
- * task_float_enable - enable preservation of non-integer context information
+ * @brief Enable preservation of non-integer context information
*
* This routine allows a task to permit a task/fiber (including itself) to
* safely share the system's floating point registers with other tasks/fibers.
@@ -317,7 +317,7 @@
/**
*
- * _FpDisable - disable preservation of non-integer context information
+ * @brief Disable preservation of non-integer context information
*
* This routine prevents the specified task/fiber (which may be the active
* task/fiber) from safely sharing any of the system's floating point registers
@@ -378,7 +378,7 @@
/**
*
- * fiber_float_disable - disable preservation of non-integer context
+ * @brief Disable preservation of non-integer context
*information
*
* This routine allows a fiber to disallow a task/fiber (including itself) from
@@ -396,7 +396,7 @@
/**
*
- * task_float_disable - disable preservation of non-integer context information
+ * @brief Disable preservation of non-integer context information
*
* This routine allows a task to disallow a task/fiber (including itself) from
* safely sharing any of the system's floating point registers with other
@@ -415,7 +415,7 @@
/**
*
- * _FpNotAvailableExcHandler - handler for "device not available" exception
+ * @brief Handler for "device not available" exception
*
* This routine is registered to handle the "device not available" exception
* (vector = 7) when the AUTOMATIC_FP_ENABLING configuration option has been
diff --git a/arch/x86/core/intboiexit.S b/arch/x86/core/intboiexit.S
index 5fd85d3..3f64b93 100644
--- a/arch/x86/core/intboiexit.S
+++ b/arch/x86/core/intboiexit.S
@@ -66,7 +66,7 @@
/**
*
- * _IntBoiExit - exit interrupt handler stub without invoking ISR
+ * @brief Exit interrupt handler stub without invoking ISR
*
* This routine exits an interrupt handler stub without invoking the associated
* ISR handler (or the EOI handler, if present). It should only be jumped to
diff --git a/arch/x86/core/intconnect.c b/arch/x86/core/intconnect.c
index f17f260..0dab75a 100644
--- a/arch/x86/core/intconnect.c
+++ b/arch/x86/core/intconnect.c
@@ -160,7 +160,7 @@
};
/**
- * _int_stub_alloc - allocate dynamic interrupt stub
+ * @brief Allocate dynamic interrupt stub
*
* @return index of the first available element of the STUB array or -1
* if all elements are used
@@ -181,7 +181,7 @@
/**
*
- * _IntVecSet - connect a routine to an interrupt vector
+ * @brief Connect a routine to an interrupt vector
*
* This routine "connects" the specified <routine> to the specified interrupt
* <vector>. On the IA-32 architecture, an interrupt vector is a value from
@@ -235,7 +235,7 @@
#if ALL_DYNAMIC_STUBS > 0
/**
*
- * irq_connect - connect a C routine to a hardware interrupt
+ * @brief Connect a C routine to a hardware interrupt
*
* This routine connects an interrupt service routine (ISR) coded in C to
* the specified hardware <irq>. An interrupt vector will be allocated to
@@ -480,7 +480,7 @@
/**
*
- * _IntVecAlloc - allocate a free interrupt vector given <priority>
+ * @brief Allocate a free interrupt vector given <priority>
*
* This routine scans the interrupt_vectors_allocated[] array for a free vector that
* satisfies the specified <priority>. It is a utility function for use only
@@ -603,7 +603,7 @@
/**
*
- * _IntVecMarkAllocated - mark interrupt vector as allocated
+ * @brief Mark interrupt vector as allocated
*
* This routine is used to "reserve" an interrupt vector that is allocated
* or assigned by any means other than _IntVecAllocate(). This marks the vector
@@ -627,7 +627,7 @@
/**
*
- * _IntVecMarkFree - mark interrupt vector as free
+ * @brief Mark interrupt vector as free
*
* This routine is used to "free" an interrupt vector that is allocated
* or assigned using _IntVecAllocate() or _IntVecMarkAllocated(). This marks the
diff --git a/arch/x86/core/inthndlset.c b/arch/x86/core/inthndlset.c
index 342ee56..36e0288 100644
--- a/arch/x86/core/inthndlset.c
+++ b/arch/x86/core/inthndlset.c
@@ -59,7 +59,7 @@
/**
*
- * irq_handler_set - set the handler in an already connected stub
+ * @brief Set the handler in an already connected stub
*
* This routine is used to modify an already fully constructed interrupt stub
* to specify a new <routine> and/or <parameter>.
diff --git a/arch/x86/core/intstub.S b/arch/x86/core/intstub.S
index 86ab2e0..58fdca4 100644
--- a/arch/x86/core/intstub.S
+++ b/arch/x86/core/intstub.S
@@ -76,7 +76,7 @@
#endif
/**
*
- * _IntEnt - inform the kernel of an interrupt
+ * @brief Inform the kernel of an interrupt
*
* This function is called from the interrupt stub created by irq_connect()
* to inform the kernel of an interrupt. This routine increments
@@ -242,7 +242,7 @@
/**
*
- * _IntExit - inform the kernel of an interrupt exit
+ * @brief Inform the kernel of an interrupt exit
*
* This function is called from the interrupt stub created by irq_connect()
* to inform the kernel that the processing of an interrupt has
@@ -391,7 +391,7 @@
/**
*
* _SpuriousIntHandler -
- * _SpuriousIntNoErrCodeHandler - spurious interrupt handler stubs
+ * @brief Spurious interrupt handler stubs
*
* Interrupt-gate descriptors are statically created for all slots in the IDT
* that point to _SpuriousIntHandler() or _SpuriousIntNoErrCodeHandler(). The
@@ -464,7 +464,7 @@
/**
*
- * irq_lock - disable interrupts on the local CPU
+ * @brief Disable interrupts on the local CPU
*
* This routine disables interrupts. It can be called from either interrupt
* or context level. This routine returns an architecture-dependent
@@ -503,7 +503,7 @@
/**
*
- * irq_unlock - enable interrupts on the local CPU
+ * @brief Enable interrupts on the local CPU
*
* This routine re-enables interrupts on the local CPU. The <key> parameter
* is an architecture-dependent lock-out key that is returned by a previous
diff --git a/arch/x86/core/msr.S b/arch/x86/core/msr.S
index 9755cee..a0fa996 100644
--- a/arch/x86/core/msr.S
+++ b/arch/x86/core/msr.S
@@ -47,7 +47,7 @@
/**
*
- * _MsrWrite - write to a model specific register (MSR)
+ * @brief Write to a model specific register (MSR)
*
* This function is used to write to an MSR.
*
@@ -78,7 +78,7 @@
/**
*
- * _MsrRead - read from a model specific register (MSR)
+ * @brief Read from a model specific register (MSR)
*
* This function is used to read from an MSR.
*
diff --git a/arch/x86/core/swap.S b/arch/x86/core/swap.S
index c137b38..3a05c4e 100644
--- a/arch/x86/core/swap.S
+++ b/arch/x86/core/swap.S
@@ -56,7 +56,7 @@
/**
*
- * _Swap - initiate a cooperative context switch
+ * @brief Initiate a cooperative context switch
*
* The _Swap() routine is invoked by various nanokernel services to effect
* a cooperative context context switch. Prior to invoking _Swap(), the
diff --git a/arch/x86/core/unaligned.S b/arch/x86/core/unaligned.S
index 0e3498b..b921d72 100644
--- a/arch/x86/core/unaligned.S
+++ b/arch/x86/core/unaligned.S
@@ -51,7 +51,7 @@
/**
*
- * _Unaligned32Write - perform an unaligned 32-bit write operation
+ * @brief Perform an unaligned 32-bit write operation
*
* This function is used during the interrupt and exception stub code
* synthesis step when writing out the 32-bit relative jmp/branch
@@ -88,7 +88,7 @@
/**
*
- * _Unaligned32Read - perform an unaligned 32-bit read operation
+ * @brief Perform an unaligned 32-bit read operation
*
* This function is used during the interrupt and exception stub code
* synthesis step when reading the 32-bit relative jmp/branch
diff --git a/arch/x86/generic_pc/system.c b/arch/x86/generic_pc/system.c
index c9b70e3..e2f53e1 100644
--- a/arch/x86/generic_pc/system.c
+++ b/arch/x86/generic_pc/system.c
@@ -88,7 +88,7 @@
/**
*
- * uart_generic_info_init - initialize initialization information for one UART
+ * @brief Initialize initialization information for one UART
*
* @return N/A
*
@@ -108,7 +108,7 @@
/**
*
- * consoleInit - initialize target-only console
+ * @brief Initialize target-only console
*
* Only used for debugging.
*
@@ -151,7 +151,7 @@
/**
*
- * _InitHardware - perform basic hardware initialization
+ * @brief Perform basic hardware initialization
*
* Initialize the Intel 8259A interrupt controller device driver and the
* Intel 8250 UART device driver.
diff --git a/arch/x86/include/advidle.h b/arch/x86/include/advidle.h
index 29a2686..01fa3a7 100644
--- a/arch/x86/include/advidle.h
+++ b/arch/x86/include/advidle.h
@@ -43,7 +43,7 @@
#ifdef CONFIG_ADVANCED_IDLE
/*
- * _AdvIdleCheckSleep - determine if advanced sleep has occurred
+ * @brief Determine if advanced sleep has occurred
*
* This routine checks if the system is recovering from advanced
* sleep or cold booting.
@@ -55,7 +55,7 @@
extern int _AdvIdleCheckSleep(void);
/*
- * _AdvIdleStart - continue kernel start-up or awaken kernel from sleep
+ * @brief Continue kernel start-up or awaken kernel from sleep
*
* This routine checks if the system is recovering from advanced sleep and
* either continues the kernel's cold boot sequence at _Cstart or resumes
@@ -73,7 +73,7 @@
);
/*
- * _AdvIdleFunc - perform advanced sleep
+ * @brief Perform advanced sleep
*
* This routine checks if the upcoming kernel idle interval is sufficient to
* justify entering advanced sleep mode. If it is, the routine puts the system
diff --git a/arch/x86/include/asmPrv.h b/arch/x86/include/asmPrv.h
index da87631..3215555 100644
--- a/arch/x86/include/asmPrv.h
+++ b/arch/x86/include/asmPrv.h
@@ -65,7 +65,7 @@
/**
*
- * NANO_CPU_EXC_CONNECT - to generate and register an exception stub
+ * @brief To generate and register an exception stub
*
* Generates an exception stub for the handler, <h>. It is registered
* on the vector given by <v> with the privilege level <d>; <d> should always
@@ -81,7 +81,7 @@
/**
*
- * NANO_CPU_EXC_CONNECT_NO_ERR - to generate and register an exception stub
+ * @brief To generate and register an exception stub
*
* Generates an exception stub for the handler, <h>. It is registered
* on the vector given by <v> with the privilege level <d>; <d> should always
diff --git a/arch/x86/include/asm_inline_gcc.h b/arch/x86/include/asm_inline_gcc.h
index 594b5e6..e5284e8 100644
--- a/arch/x86/include/asm_inline_gcc.h
+++ b/arch/x86/include/asm_inline_gcc.h
@@ -47,7 +47,7 @@
/**
*
- * EflagsGet - return the current value of the EFLAGS register
+ * @brief Return the current value of the EFLAGS register
*
* @return the EFLAGS register.
*
@@ -72,7 +72,7 @@
/**
*
- * _FpAccessDisable - disallow use of floating point capabilities
+ * @brief Disallow use of floating point capabilities
*
* This routine sets CR0[TS] to 1, which disallows the use of FP instructions
* by the currently executing context.
@@ -96,7 +96,7 @@
/**
*
- * _do_fp_ctx_save - save non-integer context information
+ * @brief Save non-integer context information
*
* This routine saves the system's "live" non-integer context into the
* specified area. If the specified task or fiber supports SSE then
@@ -128,7 +128,7 @@
/**
*
- * _do_fp_ctx_init - initialize non-integer context information
+ * @brief Initialize non-integer context information
*
* This routine initializes the system's "live" non-integer context.
* Function is invoked by _FpCtxInit(tCCS *ccs)
diff --git a/arch/x86/include/nano_private.h b/arch/x86/include/nano_private.h
index 96e3149..9fefeb3 100644
--- a/arch/x86/include/nano_private.h
+++ b/arch/x86/include/nano_private.h
@@ -762,7 +762,7 @@
/**
*
- * nanoArchInit - performs architecture-specific initialization
+ * @brief Performs architecture-specific initialization
*
* This routine performs architecture-specific initialization of the nanokernel.
* Trivial stuff is done inline; more complex initialization is done via
@@ -811,7 +811,7 @@
/**
*
- * fiberRtnValueSet - set the return value for the specified fiber (inline)
+ * @brief Set the return value for the specified fiber (inline)
*
* The register used to store the return value from a function call invocation is
* set to <value>. It is assumed that the specified <fiber> is pending, and
diff --git a/arch/x86/quark/board.h b/arch/x86/quark/board.h
index e567281..316bb36 100644
--- a/arch/x86/quark/board.h
+++ b/arch/x86/quark/board.h
@@ -154,7 +154,7 @@
/**
*
- * outByte - output byte to memory location
+ * @brief Output byte to memory location
*
* @return N/A
*
@@ -168,7 +168,7 @@
/**
*
- * inByte - obtain byte value from memory location
+ * @brief Obtain byte value from memory location
*
* This function issues the 'move' instruction to read a byte from the specified
* memory address.
@@ -196,7 +196,7 @@
/**
*
- * outWord - output word to memory location
+ * @brief Output word to memory location
*
* @return N/A
*
@@ -210,7 +210,7 @@
/**
*
- * inWord - obtain word value from memory location
+ * @brief Obtain word value from memory location
*
* This function issues the 'move' instruction to read a word from the specified
* memory address.
@@ -238,7 +238,7 @@
/**
*
- * outLong - output long word to memory location
+ * @brief Output long word to memory location
*
* @return N/A
*
@@ -252,7 +252,7 @@
/**
*
- * inLong - obtain long word value from memory location
+ * @brief Obtain long word value from memory location
*
* This function issues the 'move' instruction to read a word from the specified
* memory address.
@@ -270,7 +270,7 @@
/**
*
- * pci_pin2irq - convert PCI interrupt PIN to IRQ
+ * @brief Convert PCI interrupt PIN to IRQ
*
* The routine uses "standard design consideration" and implies that
* INTA (pin 1) -> IRQ 16
@@ -291,7 +291,7 @@
/**
*
- * pci_irq2pin - convert IRQ to PCI interrupt pin
+ * @brief Convert IRQ to PCI interrupt pin
*
* @return pin number, -1 if the result is incorrect
*
diff --git a/arch/x86/quark/system.c b/arch/x86/quark/system.c
index 66249a2..ecec172 100644
--- a/arch/x86/quark/system.c
+++ b/arch/x86/quark/system.c
@@ -57,7 +57,7 @@
/**
*
- * uart_generic_info_init - initialize initialization information for one UART
+ * @brief Initialize initialization information for one UART
*
* @return N/A
*
@@ -76,7 +76,7 @@
/**
*
- * consoleInit - initialize target-only console
+ * @brief Initialize target-only console
*
* Only used for debugging.
*
@@ -103,7 +103,7 @@
/**
*
- * _InitHardware - perform basic hardware initialization
+ * @brief Perform basic hardware initialization
*
* Initialize the Intel LOAPIC and IOAPIC device driver and the
* Intel 8250 UART device driver.
diff --git a/arch/x86/sys_fatal_error_handler.c b/arch/x86/sys_fatal_error_handler.c
index 8b6b562..8344e26 100644
--- a/arch/x86/sys_fatal_error_handler.c
+++ b/arch/x86/sys_fatal_error_handler.c
@@ -49,7 +49,7 @@
/**
*
- * _SysFatalErrorHandler - fatal error handler
+ * @brief Fatal error handler
*
* This routine implements the corrective action to be taken when the system
* detects a fatal error.
diff --git a/arch/x86/task/strtask.c b/arch/x86/task/strtask.c
index 94c5d93..7316d26 100644
--- a/arch/x86/task/strtask.c
+++ b/arch/x86/task/strtask.c
@@ -53,7 +53,7 @@
/**
*
- * _StartTaskArch - Intel-specifc parts of task initialization
+ * @brief Intel-specifc parts of task initialization
*
* @return N/A
*/
diff --git a/drivers/console/uart_console.c b/drivers/console/uart_console.c
index 7791fee..30a9a04 100644
--- a/drivers/console/uart_console.c
+++ b/drivers/console/uart_console.c
@@ -58,7 +58,7 @@
#if 0 /* NOTUSED */
/**
*
- * consoleIn - get a character from UART
+ * @brief Get a character from UART
*
* @return the character or EOF if nothing present
*/
@@ -76,7 +76,7 @@
#if defined(CONFIG_PRINTK) || defined(CONFIG_STDOUT_CONSOLE)
/**
*
- * consoleOut - output one character to UART
+ * @brief Output one character to UART
*
* Outputs both line feed and carriage return in the case of a '\n'.
*
@@ -211,7 +211,7 @@
/**
*
- * uart_console_init - initialize one UART as the console/debug port
+ * @brief Initialize one UART as the console/debug port
*
* @return N/A
*/
diff --git a/drivers/interrupt_controller/arcv2_irq_unit.c b/drivers/interrupt_controller/arcv2_irq_unit.c
index 2ca2cef..afb2b17 100644
--- a/drivers/interrupt_controller/arcv2_irq_unit.c
+++ b/drivers/interrupt_controller/arcv2_irq_unit.c
@@ -44,7 +44,7 @@
#include <board.h>
/*
- * _arc_v2_irq_unit_init - initialize the interrupt unit device driver
+ * @brief Initialize the interrupt unit device driver
*
* Initializes the interrupt unit device driver and the device
* itself.
@@ -69,7 +69,7 @@
}
/*
- * _arc_v2_irq_unit_int_eoi - send EOI signal to interrupt unit
+ * @brief Send EOI signal to interrupt unit
*
* This routine sends an EOI (End Of Interrupt) signal to the interrupt unit
* to clear a pulse-triggered interrupt.
@@ -87,7 +87,7 @@
}
/*
- * _arc_v2_irq_unit_int_trigger_set - sets an IRQ line to level/pulse trigger
+ * @brief Sets an IRQ line to level/pulse trigger
*
* Sets the IRQ line <irq> to trigger an interrupt based on the level or the
* edge of the signal. Valid values for <trigger> are _ARC_V2_INT_LEVEL and
diff --git a/drivers/interrupt_controller/i8259.c b/drivers/interrupt_controller/i8259.c
index 2e58f8d..6fa4144 100644
--- a/drivers/interrupt_controller/i8259.c
+++ b/drivers/interrupt_controller/i8259.c
@@ -118,7 +118,7 @@
/**
*
- * _i8259_init - initialize the Intel 8259A PIC device driver
+ * @brief Initialize the Intel 8259A PIC device driver
*
* This routine initializes the Intel 8259A PIC device driver and the device
* itself.
@@ -187,7 +187,7 @@
#ifndef CONFIG_SHUTOFF_PIC
/**
*
- * _i8259_eoi_master - send EOI(end of interrupt) signal to the master PIC.
+ * @brief Send EOI(end of interrupt) signal to the master PIC.
*
* This routine is called at the end of the interrupt handler.
*
@@ -209,7 +209,7 @@
/**
*
- * _i8259_eoi_slave - send EOI(end of interrupt) signal to the slave PIC.
+ * @brief Send EOI(end of interrupt) signal to the slave PIC.
*
* This routine is called at the end of the interrupt handler in the Normal
* Fully Nested Mode.
@@ -241,7 +241,7 @@
/**
*
- * __I8259IntEnable - enable/disable a specified PIC interrupt input line
+ * @brief Enable/disable a specified PIC interrupt input line
*
* This routine enables or disables a specified PIC interrupt input line. To
* enable an interrupt input line, the parameter <enable> must be non-zero.
@@ -292,7 +292,7 @@
/**
*
- * _i8259_irq_disable - disable a specified PIC interrupt input line
+ * @brief Disable a specified PIC interrupt input line
*
* This routine disables a specified PIC interrupt input line.
*
@@ -309,7 +309,7 @@
/**
*
- * _i8259_irq_enable - enable a specified PIC interrupt input line
+ * @brief Enable a specified PIC interrupt input line
*
* This routine enables a specified PIC interrupt input line.
*
diff --git a/drivers/interrupt_controller/i8259_boi.S b/drivers/interrupt_controller/i8259_boi.S
index 7726b08..410df6d 100644
--- a/drivers/interrupt_controller/i8259_boi.S
+++ b/drivers/interrupt_controller/i8259_boi.S
@@ -61,7 +61,7 @@
/**
*
- * _i8259_boi_master - detect whether it is spurious interrupt or not
+ * @brief Detect whether it is spurious interrupt or not
*
* This routine is called before the user's interrupt handler to detect the
* spurious interrupt on the master PIC. If a spurious interrupt condition is
@@ -95,7 +95,7 @@
/**
*
- * _i8259_boi_slave - detect whether it is spurious interrupt or not
+ * @brief Detect whether it is spurious interrupt or not
*
* This routine is called before the user's interrupt handler to detect the
* spurious interrupt on the slave PIC. If a spurious interrupt condition is
diff --git a/drivers/interrupt_controller/ioapic_intr.c b/drivers/interrupt_controller/ioapic_intr.c
index 3e73c74..eda4904 100644
--- a/drivers/interrupt_controller/ioapic_intr.c
+++ b/drivers/interrupt_controller/ioapic_intr.c
@@ -211,7 +211,7 @@
/**
*
- * _ioapic_init - initialize the IO APIC or xAPIC
+ * @brief Initialize the IO APIC or xAPIC
*
* This routine initializes the IO APIC or xAPIC.
*
@@ -263,7 +263,7 @@
/**
*
- * _ioapic_eoi - send EOI (End Of Interrupt) signal to IO APIC
+ * @brief Send EOI (End Of Interrupt) signal to IO APIC
*
* This routine sends an EOI signal to the IO APIC's interrupting source.
*
@@ -279,7 +279,7 @@
/**
*
- * _ioapic_eoi_get - get EOI (End Of Interrupt) information
+ * @brief Get EOI (End Of Interrupt) information
*
* This routine returns EOI signalling information for a specific IRQ.
*
@@ -319,7 +319,7 @@
/**
*
- * _ioapic_irq_enable - enable a specified APIC interrupt input line
+ * @brief Enable a specified APIC interrupt input line
*
* This routine enables a specified APIC interrupt input line.
*
@@ -334,7 +334,7 @@
/**
*
- * _ioapic_irq_disable - disable a specified APIC interrupt input line
+ * @brief Disable a specified APIC interrupt input line
*
* This routine disables a specified APIC interrupt input line.
*
@@ -349,7 +349,7 @@
/**
*
- * _ioapic_irq_set - programs the interrupt redirection table
+ * @brief Programs the interrupt redirection table
*
* This routine sets up the redirection table entry for the specified IRQ
*
@@ -370,7 +370,7 @@
/**
*
- * _ioapic_int_vec_set - program interrupt vector for specified irq
+ * @brief Program interrupt vector for specified irq
*
* The routine writes the interrupt vector in the Interrupt Redirection
* Table for specified irq number
@@ -388,7 +388,7 @@
/**
*
- * __IoApicGet - read a 32 bit IO APIC register
+ * @brief Read a 32 bit IO APIC register
*
* This routine reads the specified IO APIC register using indirect addressing.
*
@@ -416,7 +416,7 @@
/**
*
- * __IoApicSet - write a 32 bit IO APIC register
+ * @brief Write a 32 bit IO APIC register
*
* This routine writes the specified IO APIC register using indirect addressing.
*
@@ -444,7 +444,7 @@
/**
*
- * ioApicRedGetLo - get low 32 bits of Redirection Table entry
+ * @brief Get low 32 bits of Redirection Table entry
*
* This routine reads the low-order 32 bits of a Redirection Table entry.
*
@@ -470,7 +470,7 @@
/**
*
- * ioApicRedSetLo - set low 32 bits of Redirection Table entry
+ * @brief Set low 32 bits of Redirection Table entry
*
* This routine writes the low-order 32 bits of a Redirection Table entry.
*
@@ -497,7 +497,7 @@
/**
*
- * ioApicRedSetHi - set high 32 bits of Redirection Table entry
+ * @brief Set high 32 bits of Redirection Table entry
*
* This routine writes the high-order 32 bits of a Redirection Table entry.
*
@@ -524,7 +524,7 @@
/**
*
- * _IoApicRedUpdateLo - modify low 32 bits of Redirection Table entry
+ * @brief Modify low 32 bits of Redirection Table entry
*
* This routine modifies selected portions of the low-order 32 bits of a
* Redirection Table entry, as indicated by the associate bit mask.
@@ -550,7 +550,7 @@
/**
*
- * _IoApicRteConfigSet - write to the RTE config register for specified IRQ
+ * @brief Write to the RTE config register for specified IRQ
*
* This routine writes the specified 32-bit <value> into the RTE configuration
* register for the specified <irq> (0 to (IOAPIC_NUM_RTES - 1))
@@ -578,7 +578,7 @@
/**
*
- * _IoApicRedirRegSet - write to the specified MSI redirection register
+ * @brief Write to the specified MSI redirection register
*
* This routine writes the 32-bit <value> into the redirection register
* specified by <reg>.
diff --git a/drivers/interrupt_controller/loapic_intr.c b/drivers/interrupt_controller/loapic_intr.c
index 5460e5c..41722be 100644
--- a/drivers/interrupt_controller/loapic_intr.c
+++ b/drivers/interrupt_controller/loapic_intr.c
@@ -200,7 +200,7 @@
/**
*
- * _loapic_init - initialize the Local APIC or xAPIC
+ * @brief Initialize the Local APIC or xAPIC
*
* This routine initializes Local APIC or xAPIC.
*
@@ -262,7 +262,7 @@
/**
*
- * _loapic_enable - enable the Local xAPIC
+ * @brief Enable the Local xAPIC
*
* This routine enables the Local xAPIC.
*
@@ -280,7 +280,7 @@
/**
*
- * _loapic_disable - disable the Local xAPIC
+ * @brief Disable the Local xAPIC
*
* This routine disables the Local xAPIC.
*
@@ -298,7 +298,7 @@
/**
*
- * _loapic_eoi - send EOI (End Of Interrupt) signal to Local APIC
+ * @brief send EOI (End Of Interrupt) signal to Local APIC
*
* This routine sends an EOI signal to the Local APIC's interrupting source.
*
@@ -313,7 +313,7 @@
/**
*
- * _loapic_int_vec_set - set the vector field in the specified RTE
+ * @brief Set the vector field in the specified RTE
*
* This routine is utilized by the BSP provided routined _SysIntVecAllocate()
* which in turn is provided to support the irq_connect() API. Once
@@ -356,7 +356,7 @@
/**
*
- * _loapic_irq_enable - enable an individual LOAPIC interrupt (IRQ)
+ * @brief Enable an individual LOAPIC interrupt (IRQ)
*
* This routine clears the interrupt mask bit in the LVT for the specified IRQ
*
@@ -386,7 +386,7 @@
/**
*
- * _loapic_irq_disable - disable an individual LOAPIC interrupt (IRQ)
+ * @brief Disable an individual LOAPIC interrupt (IRQ)
*
* This routine clears the interrupt mask bit in the LVT for the specified IRQ
*
diff --git a/drivers/interrupt_controller/system_apic.c b/drivers/interrupt_controller/system_apic.c
index 5c357f8..41a89ce 100644
--- a/drivers/interrupt_controller/system_apic.c
+++ b/drivers/interrupt_controller/system_apic.c
@@ -45,7 +45,7 @@
/**
*
- * _SysIntVecAlloc - allocate interrupt vector
+ * @brief Allocate interrupt vector
*
* This BSP provided routine supports the irq_connect() API. This
* routine is required to perform the following 3 functions:
@@ -63,13 +63,13 @@
*
* The board virtualizes IRQs as follows:
*
- * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC
- * - The remaining IRQs are provided by the LOAPIC.
+ * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC
+ * - The remaining IRQs are provided by the LOAPIC.
*
* Thus, for example, if the IOAPIC supports 24 IRQs:
*
- * - IRQ0 to IRQ23 map to IOAPIC IRQ0 to IRQ23
- * - IRQ24 to IRQ29 map to LOAPIC LVT entries as follows:
+ * - IRQ0 to IRQ23 map to IOAPIC IRQ0 to IRQ23
+ * - IRQ24 to IRQ29 map to LOAPIC LVT entries as follows:
*
* IRQ24 -> LOAPIC_TIMER
* IRQ25 -> LOAPIC_THERMAL
@@ -172,7 +172,7 @@
/**
*
- * _SysIntVecProgram - program interrupt controller
+ * @brief Program interrupt controller
*
* This BSP provided routine programs the appropriate interrupt controller
* with the given vector based on the given IRQ parameter.
@@ -182,9 +182,9 @@
*
* The Clanton board virtualizes IRQs as follows:
*
- * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC so the IOAPIC
+ * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC so the IOAPIC
* is programmed for these IRQs
- * - The remaining IRQs are provided by the LOAPIC and hence the LOAPIC is
+ * - The remaining IRQs are provided by the LOAPIC and hence the LOAPIC is
* programmed.
*
* The IOAPIC_NUM_RTES macro is provided by board.h, and it specifies the number
@@ -207,7 +207,7 @@
/**
*
- * irq_enable - enable an individual interrupt (IRQ)
+ * @brief Enable an individual interrupt (IRQ)
*
* The public interface for enabling/disabling a specific IRQ for the IA-32
* architecture is defined as follows in include/nanokernel/x86/arch.h
@@ -233,7 +233,7 @@
/**
*
- * irq_disable - disable an individual interrupt (IRQ)
+ * @brief Disable an individual interrupt (IRQ)
*
* The irq_disable() routine is provided by the BSP due to the
* IRQ virtualization that is performed by this BSP. See the comments
diff --git a/drivers/interrupt_controller/system_pic.c b/drivers/interrupt_controller/system_pic.c
index 72e5e4c..c68dcb1 100644
--- a/drivers/interrupt_controller/system_pic.c
+++ b/drivers/interrupt_controller/system_pic.c
@@ -47,7 +47,7 @@
/**
*
- * _SysIntVecAlloc - allocate interrupt vector
+ * @brief Allocate interrupt vector
*
* This BSP provided routine supports the irq_connect() API. This
* routine performs the following functions:
@@ -64,8 +64,8 @@
*
* The pcPentium4 board virtualizes IRQs as follows:
*
- * - IRQ0 to IRQ7 are provided by the master i8259 PIC
- * - IRQ8 to IRQ15 are provided by the slave i8259 PIC
+ * - IRQ0 to IRQ7 are provided by the master i8259 PIC
+ * - IRQ8 to IRQ15 are provided by the slave i8259 PIC
*
* @return the allocated interrupt vector
*
@@ -149,7 +149,7 @@
/**
*
- * _SysIntVecProgram - program interrupt controller
+ * @brief Program interrupt controller
*
* This BSP provided routine programs the appropriate interrupt controller
* with the given vector based on the given IRQ parameter.
diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c
index 43a9e54..2910563 100644
--- a/drivers/pci/pci.c
+++ b/drivers/pci/pci.c
@@ -169,7 +169,7 @@
/**
*
- * pci_get_bar_config - return the configuration for the specified BAR
+ * @brief Return the configuration for the specified BAR
*
* @return 0 if BAR is implemented, -1 if not.
*/
@@ -214,7 +214,7 @@
/**
*
- * pci_bar_params_get - retrieve the I/O address and IRQ of the specified BAR
+ * @brief Retrieve the I/O address and IRQ of the specified BAR
*
* @return -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved
*
@@ -265,7 +265,7 @@
/**
*
- * pci_dev_scan - scan the specified PCI device for all sub functions
+ * @brief Scan the specified PCI device for all sub functions
*
* @return 1 if a device has been found, 0 otherwise.
*
@@ -376,7 +376,7 @@
/**
*
- * pci_bus_scan - scans PCI bus for devices
+ * @brief Scans PCI bus for devices
*
* The routine scans the PCI bus for the devices on criterias provided in the
* given dev_info at first call. Which criterias can be class and/or
@@ -430,7 +430,7 @@
#ifdef CONFIG_PCI_DEBUG
/**
*
- * pci_show - Show PCI device
+ * @brief Show PCI device
*
* Shows the PCI device found provided as parameter.
*
diff --git a/drivers/pci/pci_config.c b/drivers/pci/pci_config.c
index c859d68..4bdb1ad 100644
--- a/drivers/pci/pci_config.c
+++ b/drivers/pci/pci_config.c
@@ -54,7 +54,7 @@
/**
*
- * pci_config_out_long - write a 32bit data to pci reg in offset
+ * @brief Write a 32bit data to pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number
@@ -84,7 +84,7 @@
/**
*
- * pci_config_out_word - write a 16bit data to pci reg in offset
+ * @brief Write a 16bit data to pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@@ -114,7 +114,7 @@
/**
*
- * pci_config_out_byte - write a 8bit data to pci reg in offset
+ * @brief Write a 8bit data to pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@@ -144,7 +144,7 @@
/**
*
- * pci_config_in_long - read a 32bit data from pci reg in offset
+ * @brief Read a 32bit data from pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@@ -175,7 +175,7 @@
/**
*
- * pci_config_in_word - read in a 16bit data from a pci reg in offset
+ * @brief Read in a 16bit data from a pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@@ -212,7 +212,7 @@
/**
*
- * pci_config_in_byte - read in a 8bit data from a pci reg in offset
+ * @brief Read in a 8bit data from a pci reg in offset
*
* @param bus_no Bus number.
* @param device_no Device number.
@@ -249,7 +249,7 @@
/**
*
- * pci_config_ext_cap_ptr_find - find extended capability in ECP linked list
+ * @brief Find extended capability in ECP linked list
*
* This routine searches for an extended capability in the linked list of
* capabilities in config space. If found, the offset of the first byte
diff --git a/drivers/pci/pci_interface.c b/drivers/pci/pci_interface.c
index 4af3252..972b9b9 100644
--- a/drivers/pci/pci_interface.c
+++ b/drivers/pci/pci_interface.c
@@ -54,7 +54,7 @@
/**
*
- * pci_ctrl_read - read a PCI controller register
+ * @brief Read a PCI controller register
*
* This routine reads the specified register from the PCI controller and
* places the data into the provided buffer.
@@ -88,7 +88,7 @@
/**
*
- * pci_ctrl_write - write a PCI controller register
+ * @brief Write a PCI controller register
*
* This routine writes the provided data to the specified register in the PCI
* controller.
@@ -123,7 +123,7 @@
/**
*
- * pci_ctrl_data_read - read the PCI controller data register
+ * @brief Read the PCI controller data register
*
* This routine reads the data register of the specified PCI controller.
*
@@ -149,7 +149,7 @@
/**
*
- * pci_ctrl_data_write - write the PCI controller data register
+ * @brief Write the PCI controller data register
*
* This routine writes the provided data to the data register of the
* specified PCI controller.
@@ -176,7 +176,7 @@
/**
*
- * pci_ctrl_addr_write - write the PCI controller address register
+ * @brief Write the PCI controller address register
*
* This routine writes the provided data to the address register of the
* specified PCI controller.
@@ -202,7 +202,7 @@
/**
*
- * pci_read - read a PCI register from a device
+ * @brief Read a PCI register from a device
*
* This routine reads data from a PCI device's configuration space. The
* device and register to read is specified by the address parameter ("addr")
@@ -292,7 +292,7 @@
/**
*
- * pci_write - write a to a PCI register
+ * @brief Write a to a PCI register
*
* This routine writes data to a PCI device's configuration space. The
* device and register to write is specified by the address parameter ("addr")
@@ -381,7 +381,7 @@
/**
*
- * pci_header_get - get the PCI header for a device
+ * @brief Get the PCI header for a device
*
* This routine reads the PCI header for the specified device and puts the
* result in the supplied header structure.
diff --git a/drivers/random/rand32-timer.c b/drivers/random/rand32-timer.c
index 18672d7..a0ef794 100644
--- a/drivers/random/rand32-timer.c
+++ b/drivers/random/rand32-timer.c
@@ -55,7 +55,7 @@
/**
*
- * sys_rand32_init - initialize the random number generator
+ * @brief Initialize the random number generator
*
* The non-random number generator does not require any initialization.
* This routine is automatically invoked by the kernel during system
@@ -71,7 +71,7 @@
/**
*
- * sys_rand32_get - get a 32 bit random number
+ * @brief Get a 32 bit random number
*
* The non-random number generator returns values that are based off the
* target's clock counter, which means that successive calls will return
diff --git a/drivers/random/rand32-timestamp.c b/drivers/random/rand32-timestamp.c
index 157d054..fa184a0 100644
--- a/drivers/random/rand32-timestamp.c
+++ b/drivers/random/rand32-timestamp.c
@@ -44,7 +44,7 @@
/**
*
- * sys_rand32_init - initialize the random number generator
+ * @brief Initialize the random number generator
*
* The non-random number generator does not require any initialization.
* Routine is automatically invoked by the kernel during system startup.
@@ -58,7 +58,7 @@
/**
*
- * sys_rand32_get - get a 32 bit random number
+ * @brief Get a 32 bit random number
*
* The non-random number generator returns values that are based off the
* CPU's timestamp counter, which means that successive calls will normally
diff --git a/drivers/serial/k20UartDrv.c b/drivers/serial/k20UartDrv.c
index 783abe8..e5f9e66 100644
--- a/drivers/serial/k20UartDrv.c
+++ b/drivers/serial/k20UartDrv.c
@@ -61,7 +61,7 @@
/**
*
- * uart_init - initialize UART channel
+ * @brief Initialize UART channel
*
* This routine is called to reset the chip in a quiescent state.
* It is assumed that this function is called only once per UART.
@@ -109,7 +109,7 @@
/**
*
- * uart_poll_in - poll the device for input.
+ * @brief Poll the device for input.
*
* @return 0 if a character arrived, -1 if the input buffer if empty.
*/
@@ -131,7 +131,7 @@
/**
*
- * uart_poll_out - output a character in polled mode.
+ * @brief Output a character in polled mode.
*
* Checks if the transmitter is empty. If empty, a character is written to
* the data register.
@@ -161,7 +161,7 @@
/**
*
- * uart_fifo_fill - fill FIFO with data
+ * @brief Fill FIFO with data
* @return number of bytes sent
*/
@@ -183,7 +183,7 @@
/**
*
- * uart_fifo_read - read data from FIFO
+ * @brief Read data from FIFO
*
* @return number of bytes read
*/
@@ -205,7 +205,7 @@
/**
*
- * uart_irq_tx_enable - enable TX interrupt
+ * @brief Enable TX interrupt
*
* @return N/A
*/
@@ -221,7 +221,7 @@
/**
*
- * uart_irq_tx_disable - disable TX interrupt in IER
+ * @brief Disable TX interrupt in IER
*
* @return N/A
*/
@@ -237,7 +237,7 @@
/**
*
- * uart_irq_tx_ready - check if Tx IRQ has been raised
+ * @brief Check if Tx IRQ has been raised
*
* @return 1 if an IRQ is ready, 0 otherwise
*/
@@ -252,7 +252,7 @@
/**
*
- * uart_irq_rx_enable - enable RX interrupt in IER
+ * @brief Enable RX interrupt in IER
*
* @return N/A
*/
@@ -268,7 +268,7 @@
/**
*
- * uart_irq_rx_disable - disable RX interrupt in IER
+ * @brief Disable RX interrupt in IER
*
* @return N/A
*/
@@ -284,7 +284,7 @@
/**
*
- * uart_irq_rx_ready - check if Rx IRQ has been raised
+ * @brief Check if Rx IRQ has been raised
*
* @return 1 if an IRQ is ready, 0 otherwise
*/
@@ -299,7 +299,7 @@
/**
*
- * uart_irq_err_enable - enable error interrupt
+ * @brief Enable error interrupt
*
* @return N/A
*/
@@ -318,7 +318,7 @@
/**
*
- * uart_irq_err_disable - disable error interrupt
+ * @brief Disable error interrupt
*
* @return N/A
*/
@@ -338,7 +338,7 @@
/**
*
- * uart_irq_is_pending - check if Tx or Rx IRQ is pending
+ * @brief Check if Tx or Rx IRQ is pending
*
* @return 1 if a Tx or Rx IRQ is pending, 0 otherwise
*/
@@ -357,7 +357,7 @@
/**
*
- * uart_irq_update - update IRQ status
+ * @brief Update IRQ status
*
* @return always 1
*/
@@ -369,7 +369,7 @@
/**
*
- * uart_irq_get - returns UART interrupt number
+ * @brief Returns UART interrupt number
*
* Returns the IRQ number used by the specified UART port
*
diff --git a/drivers/serial/ns16550.c b/drivers/serial/ns16550.c
index 125fc3e..cfb8699 100644
--- a/drivers/serial/ns16550.c
+++ b/drivers/serial/ns16550.c
@@ -259,7 +259,7 @@
/**
*
- * uart_init - initialize the chip
+ * @brief Initialize the chip
*
* This routine is called to reset the chip in a quiescent state.
*
@@ -312,7 +312,7 @@
/**
*
- * uart_poll_in - poll the device for input.
+ * @brief Poll the device for input.
*
* @return 0 if a character arrived, -1 if the input buffer if empty.
*/
@@ -332,7 +332,7 @@
/**
*
- * uart_poll_out - output a character in polled mode.
+ * @brief Output a character in polled mode.
*
* Checks if the transmitter is empty. If empty, a character is written to
* the data register.
@@ -359,7 +359,7 @@
#if CONFIG_UART_INTERRUPT_DRIVEN
/**
*
- * uart_fifo_fill - fill FIFO with data
+ * @brief Fill FIFO with data
*
* @return number of bytes sent
*/
@@ -379,7 +379,7 @@
/**
*
- * uart_fifo_read - read data from FIFO
+ * @brief Read data from FIFO
*
* @return number of bytes read
*/
@@ -400,7 +400,7 @@
/**
*
- * uart_irq_tx_enable - enable TX interrupt in IER
+ * @brief Enable TX interrupt in IER
*
* @return N/A
*/
@@ -414,7 +414,7 @@
/**
*
- * uart_irq_tx_disable - disable TX interrupt in IER
+ * @brief Disable TX interrupt in IER
*
* @return N/A
*/
@@ -427,7 +427,7 @@
/**
*
- * uart_irq_tx_ready - check if Tx IRQ has been raised
+ * @brief Check if Tx IRQ has been raised
*
* @return N/A
*/
@@ -440,7 +440,7 @@
/**
*
- * _uart_irq_rx_enable - enable RX interrupt in IER
+ * @brief Enable RX interrupt in IER
*
* @return N/A
*/
@@ -454,7 +454,7 @@
/**
*
- * uart_irq_rx_disable - disable RX interrupt in IER
+ * @brief Disable RX interrupt in IER
*
* @return N/A
*/
@@ -467,7 +467,7 @@
/**
*
- * uart_irq_rx_ready - check if Rx IRQ has been raised
+ * @brief Check if Rx IRQ has been raised
*
* @return 1 if an IRQ is ready, 0 otherwise
*/
@@ -480,7 +480,7 @@
/**
*
- * uart_irq_err_enable - enable error interrupt in IER
+ * @brief Enable error interrupt in IER
*
* @return N/A
*/
@@ -493,7 +493,7 @@
/**
*
- * uart_irq_err_disable - disable error interrupt in IER
+ * @brief Disable error interrupt in IER
*
* @return 1 if an IRQ is ready, 0 otherwise
*/
@@ -506,7 +506,7 @@
/**
*
- * uart_irq_is_pending - check if any IRQ is pending
+ * @brief Check if any IRQ is pending
*
* @return 1 if an IRQ is pending, 0 otherwise
*/
@@ -519,7 +519,7 @@
/**
*
- * uart_irq_update - update cached contents of IIR
+ * @brief Update cached contents of IIR
*
* @return always 1
*/
@@ -534,7 +534,7 @@
/**
*
- * uart_irq_get - returns UART interrupt number
+ * @brief Returns UART interrupt number
*
* Returns the IRQ number used by the specified UART port
*
diff --git a/drivers/serial/nsim_uart.c b/drivers/serial/nsim_uart.c
index 1fca9f9..6f826af 100644
--- a/drivers/serial/nsim_uart.c
+++ b/drivers/serial/nsim_uart.c
@@ -53,7 +53,7 @@
static struct uart __noinit uart[CONFIG_UART_NUM_SYSTEM_PORTS];
/*
- * uart_init - initialize fake serial port
+ * @brief Initialize fake serial port
* @which: port number
* @init_info: pointer to initialization information
*/
@@ -66,7 +66,7 @@
}
/*
- * uart_poll_out - output a character to serial port
+ * @brief Output a character to serial port
* @port: port number
* @c: character to output
*/
diff --git a/drivers/serial/stellarisUartDrv.c b/drivers/serial/stellarisUartDrv.c
index da99c71..9e74fb8 100644
--- a/drivers/serial/stellarisUartDrv.c
+++ b/drivers/serial/stellarisUartDrv.c
@@ -155,7 +155,7 @@
/**
*
- * baudrateSet - set the baud rate
+ * @brief Set the baud rate
*
* This routine set the given baud rate for the UART.
*
@@ -186,7 +186,7 @@
/**
*
- * enable - enable the UART
+ * @brief Enable the UART
*
* This routine enables the given UART.
*
@@ -202,7 +202,7 @@
/**
*
- * disable - disable the UART
+ * @brief Disable the UART
*
* This routine disables the given UART.
*
@@ -235,7 +235,7 @@
/**
*
- * lineControlDefaultsSet - set the default UART line controls
+ * @brief Set the default UART line controls
*
* This routine sets the given UART's line controls to their default settings.
*
@@ -251,7 +251,7 @@
/**
*
- * uart_init - initialize UART channel
+ * @brief Initialize UART channel
*
* This routine is called to reset the chip in a quiescent state.
* It is assumed that this function is called only once per UART.
@@ -272,7 +272,7 @@
/**
*
- * pollTxReady - get the UART transmit ready status
+ * @brief Get the UART transmit ready status
*
* This routine returns the given UART's transmit ready status.
*
@@ -288,7 +288,7 @@
/**
*
- * uart_poll_in - poll the device for input.
+ * @brief Poll the device for input.
*
* @return 0 if a character arrived, -1 if the input buffer if empty.
*/
@@ -310,7 +310,7 @@
/**
*
- * uart_poll_out - output a character in polled mode.
+ * @brief Output a character in polled mode.
*
* Checks if the transmitter is empty. If empty, a character is written to
* the data register.
@@ -333,7 +333,7 @@
/**
*
- * uart_fifo_fill - fill FIFO with data
+ * @brief Fill FIFO with data
*
* @return number of bytes sent
*/
@@ -355,7 +355,7 @@
/**
*
- * uart_fifo_read - read data from FIFO
+ * @brief Read data from FIFO
*
* @return number of bytes read
*/
@@ -377,7 +377,7 @@
/**
*
- * uart_irq_tx_enable - enable TX interrupt
+ * @brief Enable TX interrupt
*
* @return N/A
*/
@@ -432,7 +432,7 @@
/**
*
- * uart_irq_tx_disable - disable TX interrupt in IER
+ * @brief Disable TX interrupt in IER
*
* @return N/A
*/
@@ -447,7 +447,7 @@
/**
*
- * uart_irq_tx_ready - check if Tx IRQ has been raised
+ * @brief Check if Tx IRQ has been raised
*
* @return 1 if a Tx IRQ is pending, 0 otherwise
*/
@@ -462,7 +462,7 @@
/**
*
- * uart_irq_rx_enable - enable RX interrupt in IER
+ * @brief Enable RX interrupt in IER
*
* @return N/A
*/
@@ -477,7 +477,7 @@
/**
*
- * uart_irq_rx_disable - disable RX interrupt in IER
+ * @brief Disable RX interrupt in IER
*
* @return N/A
*/
@@ -492,7 +492,7 @@
/**
*
- * uart_irq_rx_ready - check if Rx IRQ has been raised
+ * @brief Check if Rx IRQ has been raised
*
* @return 1 if an IRQ is ready, 0 otherwise
*/
@@ -507,7 +507,7 @@
/**
*
- * uart_irq_err_enable - enable error interrupts
+ * @brief Enable error interrupts
*
* @return N/A
*/
@@ -523,7 +523,7 @@
/**
*
- * uart_irq_err_disable - disable error interrupts
+ * @brief Disable error interrupts
*
* @return N/A
*/
@@ -539,7 +539,7 @@
/**
*
- * uart_irq_is_pending - check if Tx or Rx IRQ is pending
+ * @brief Check if Tx or Rx IRQ is pending
*
* @return 1 if a Tx or Rx IRQ is pending, 0 otherwise
*/
@@ -555,7 +555,7 @@
/**
*
- * uart_irq_update - update IRQ status
+ * @brief Update IRQ status
*
* @return always 1
*/
@@ -567,7 +567,7 @@
/**
*
- * uart_irq_get - returns UART interrupt number
+ * @brief Returns UART interrupt number
*
* Returns the IRQ number used by the specified UART port
*
diff --git a/drivers/timer/arcv2_timer0.c b/drivers/timer/arcv2_timer0.c
index e166124..a1f56fc 100644
--- a/drivers/timer/arcv2_timer0.c
+++ b/drivers/timer/arcv2_timer0.c
@@ -70,7 +70,7 @@
/**
*
- * enable - enable the timer with the given limit/countup value
+ * @brief Enable the timer with the given limit/countup value
*
* This routine sets up the timer for operation by:
* - setting value to which the timer will count up to;
@@ -97,7 +97,7 @@
/**
*
- * count_get - get the current counter value
+ * @brief Get the current counter value
*
* This routine gets the value from the timer's count register. This
* value is the 'time' elapsed from the starting count (assumed to be 0).
@@ -113,7 +113,7 @@
/**
*
- * limit_get - get the limit/countup value
+ * @brief Get the limit/countup value
*
* This routine gets the value from the timer's limit register, which is the
* value to which the timer will count up to.
@@ -129,7 +129,7 @@
/**
*
- * _timer_int_handler - system clock periodic tick handler
+ * @brief System clock periodic tick handler
*
* This routine handles the system clock periodic tick interrupt. A TICK_EVENT
* event is pushed onto the microkernel stack.
@@ -155,7 +155,7 @@
/**
*
- * timer_driver - initialize and enable the system clock
+ * @brief Initialize and enable the system clock
*
* This routine is used to program the ARCv2 timer to deliver interrupts at the
* rate specified via the 'sys_clock_us_per_tick' global variable.
@@ -191,7 +191,7 @@
/**
*
- * timer_read - read the BSP timer hardware
+ * @brief Read the BSP timer hardware
*
* This routine returns the current time in terms of timer hardware clock cycles.
*
@@ -206,7 +206,7 @@
#if defined(CONFIG_SYSTEM_TIMER_DISABLE)
/**
*
- * timer_disable - stop announcing ticks into the kernel
+ * @brief Stop announcing ticks into the kernel
*
* This routine disables timer interrupt generation and delivery.
* Note that the timer's counting cannot be stopped by software.
diff --git a/drivers/timer/cortex_m_timer.c b/drivers/timer/cortex_m_timer.c
index 84a6d5e..bb006cd 100644
--- a/drivers/timer/cortex_m_timer.c
+++ b/drivers/timer/cortex_m_timer.c
@@ -129,7 +129,7 @@
/**
*
- * sysTickStop - stop the timer
+ * @brief Stop the timer
*
* This routine disables the systick counter.
*
@@ -158,7 +158,7 @@
/**
*
- * sysTickStart - start the timer
+ * @brief Start the timer
*
* This routine enables the systick counter.
*
@@ -185,7 +185,7 @@
/**
*
- * sysTickCurrentGet - get the current counter value
+ * @brief Get the current counter value
*
* This routine gets the value from the timer's current value register. This
* value is the 'time' remaining to decrement before the timer triggers an
@@ -202,7 +202,7 @@
/**
*
- * sysTickReloadGet - get the reload/countdown value
+ * @brief Get the reload/countdown value
*
* This routine returns the value from the reload value register.
*
@@ -219,7 +219,7 @@
/**
*
- * sysTickReloadSet - set the reload/countdown value
+ * @brief Set the reload/countdown value
*
* This routine sets value from which the timer will count down and also
* sets the timer's current value register to zero.
@@ -246,7 +246,7 @@
/**
*
- * _TIMER_INT_HANDLER - system clock tick handler
+ * @brief System clock tick handler
*
* This routine handles the system clock tick interrupt. A TICK_EVENT event
* is pushed onto the microkernel stack.
@@ -379,7 +379,7 @@
/**
*
- * sysTickTicklessIdleInit - initialize the tickless idle feature
+ * @brief Initialize the tickless idle feature
*
* This routine initializes the tickless idle feature by calculating the
* necessary hardware-specific parameters.
@@ -460,7 +460,7 @@
/**
*
- * _timer_idle_enter - Place the system timer into idle state
+ * @brief Place the system timer into idle state
*
* Re-program the timer to enter into the idle state for the given number of
* ticks. It is set to a "one shot" mode where it will fire in the number of
@@ -516,7 +516,7 @@
/**
*
- * _timer_idle_exit - handling of tickless idle when interrupted
+ * @brief Handling of tickless idle when interrupted
*
* The routine, called by _sys_power_save_idle_exit, is responsible for taking
* the timer out of idle mode and generating an interrupt at the next
@@ -608,7 +608,7 @@
/**
*
- * timer_driver - initialize and enable the system clock
+ * @brief Initialize and enable the system clock
*
* This routine is used to program the systick to deliver interrupts at the
* rate specified via the 'sys_clock_us_per_tick' global variable.
@@ -648,7 +648,7 @@
/**
*
- * timer_read - read the BSP timer hardware
+ * @brief Read the BSP timer hardware
*
* This routine returns the current time in terms of timer hardware clock cycles.
* Some kernel facilities (e.g. benchmarking code) directly call timer_read()
@@ -670,7 +670,7 @@
/**
*
- * timer_disable - stop announcing ticks into the kernel
+ * @brief Stop announcing ticks into the kernel
*
* This routine disables the systick so that timer interrupts are no
* longer delivered.
diff --git a/drivers/timer/hpet.c b/drivers/timer/hpet.c
index 3d363e0..6710f09 100644
--- a/drivers/timer/hpet.c
+++ b/drivers/timer/hpet.c
@@ -221,7 +221,7 @@
/**
*
- * _hpetMainCounterAtomic - safely read the main HPET up counter
+ * @brief Safely read the main HPET up counter
*
* This routine simulates an atomic read of the 64-bit system clock on CPUs
* that only support 32-bit memory accesses. The most significant word
@@ -250,7 +250,7 @@
/**
*
- * _timer_int_handler - system clock tick handler
+ * @brief System clock tick handler
*
* This routine handles the system clock tick interrupt. A TICK_EVENT event
* is pushed onto the microkernel stack.
@@ -351,7 +351,7 @@
/**
*
- * _timer_idle_enter - Place system timer into idle state
+ * @brief Place system timer into idle state
*
* Re-program the timer to enter into the idle state for the given number of
* ticks (-1 means infinite number of ticks).
@@ -380,7 +380,7 @@
/**
*
- * _timer_idle_exit - Take system timer out of idle state
+ * @brief Take system timer out of idle state
*
* Determine how long timer has been idling and reprogram it to interrupt at the
* next tick.
@@ -489,7 +489,7 @@
/**
*
- * timer_driver - initialize and enable the system clock
+ * @brief Initialize and enable the system clock
*
* This routine is used to program the HPET to deliver interrupts at the
* rate specified via the 'sys_clock_us_per_tick' global variable.
@@ -622,7 +622,7 @@
/**
*
- * timer_read - read the BSP timer hardware
+ * @brief Read the BSP timer hardware
*
* This routine returns the current time in terms of timer hardware clock cycles.
*
@@ -642,7 +642,7 @@
/**
*
- * timer_disable - stop announcing ticks into the kernel
+ * @brief Stop announcing ticks into the kernel
*
* This routine disables the HPET so that timer interrupts are no
* longer delivered.
diff --git a/drivers/timer/i8253.c b/drivers/timer/i8253.c
index 677a26e..f84eefc 100644
--- a/drivers/timer/i8253.c
+++ b/drivers/timer/i8253.c
@@ -144,7 +144,7 @@
/**
*
- * _i8253CounterRead - read the i8253 counter register's value
+ * @brief Read the i8253 counter register's value
*
* This routine reads the 16 bit value from the i8253 counter register.
*
@@ -171,7 +171,7 @@
/**
*
- * _i8253CounterSet - set the i8253 counter register's value
+ * @brief Set the i8253 counter register's value
*
* This routine sets the 16 bit value from which the i8253 timer will
* decrement and sets that counter register to its value.
@@ -194,7 +194,7 @@
/**
*
- * _i8253CounterPeriodic - set the i8253 timer to fire periodically
+ * @brief Set the i8253 timer to fire periodically
*
* This routine sets the i8253 to fire on a periodic basis.
*
@@ -214,7 +214,7 @@
#if defined(TIMER_SUPPORTS_TICKLESS)
/**
*
- * _i8253CounterOneShot - set the i8253 timer to fire once only
+ * @brief Set the i8253 timer to fire once only
*
* This routine sets the i8253 to fire once only.
*
@@ -234,7 +234,7 @@
/**
*
- * _timer_int_handler - system clock periodic tick handler
+ * @brief System clock periodic tick handler
*
* This routine handles the system clock periodic tick interrupt. A TICK_EVENT
* event is pushed onto the microkernel stack.
@@ -307,7 +307,7 @@
#if defined(TIMER_SUPPORTS_TICKLESS)
/**
*
- * _i8253TicklessIdleInit - initialize the tickless idle feature
+ * @brief Initialize the tickless idle feature
*
* This routine initializes the tickless idle feature. Note that maximum
* number of ticks that can elapse during a "tickless idle" is limited by
@@ -345,7 +345,7 @@
/**
*
- * _timer_idle_enter - Place system timer into idle state
+ * @brief Place system timer into idle state
*
* Re-program the timer to enter into the idle state for the given number of
* ticks. It is placed into one shot mode where it will fire in the number of
@@ -402,7 +402,7 @@
/**
*
- * _timer_idle_exit - handling of tickless idle when interrupted
+ * @brief Handling of tickless idle when interrupted
*
* The routine is responsible for taking the timer out of idle mode and
* generating an interrupt at the next tick interval.
@@ -468,7 +468,7 @@
/**
*
- * timer_driver - initialize and enable the system clock
+ * @brief Initialize and enable the system clock
*
* This routine is used to program the PIT to deliver interrupts at the
* rate specified via the 'sys_clock_us_per_tick' global variable.
@@ -503,7 +503,7 @@
/**
*
- * timer_read - read the BSP timer hardware
+ * @brief Read the BSP timer hardware
*
* This routine returns the current time in terms of timer hardware clock cycles.
*
@@ -558,7 +558,7 @@
#if defined(CONFIG_SYSTEM_TIMER_DISABLE)
/**
*
- * timer_disable - stop announcing ticks into the kernel
+ * @brief Stop announcing ticks into the kernel
*
* This routine simply disables the PIT counter such that interrupts are no
* longer delivered.
diff --git a/drivers/timer/loapic_timer.c b/drivers/timer/loapic_timer.c
index 2f46fba..f4dec0d 100644
--- a/drivers/timer/loapic_timer.c
+++ b/drivers/timer/loapic_timer.c
@@ -134,7 +134,7 @@
/**
*
- * _loApicTimerPeriodic - set the timer for periodic mode
+ * @brief Set the timer for periodic mode
*
* This routine sets the timer for periodic mode.
*
@@ -153,7 +153,7 @@
defined(CONFIG_SYSTEM_TIMER_DISABLE)
/**
*
- * _loApicTimerStop - stop the timer
+ * @brief Stop the timer
*
* This routine stops the timer.
*
@@ -172,7 +172,7 @@
defined(LOAPIC_TIMER_PERIODIC_WORKAROUND)
/**
*
- * _loApicTimerStart - start the timer
+ * @brief Start the timer
*
* This routine starts the timer.
*
@@ -189,7 +189,7 @@
/**
*
- * _loApicTimerSetCount - set countdown value
+ * @brief Set countdown value
*
* This routine sets value from which the timer will count down.
*
@@ -208,7 +208,7 @@
#if defined(TIMER_SUPPORTS_TICKLESS)
/**
*
- * _loApicTimerOneShot - set the timer for one shot mode
+ * @brief Set the timer for one shot mode
*
* This routine sets the timer for one shot mode.
*
@@ -225,7 +225,7 @@
/**
*
- * _loApicTimerSetDivider - set the rate at which the timer is decremented
+ * @brief Set the rate at which the timer is decremented
*
* This routine sets rate at which the timer is decremented to match the
* external bus frequency.
@@ -242,7 +242,7 @@
/**
*
- * _loApicTimerGetRemaining - get the value from the current count register
+ * @brief Get the value from the current count register
*
* This routine gets the value from the timer's current count register. This
* value is the 'time' remaining to decrement before the timer triggers an
@@ -260,7 +260,7 @@
#if defined(TIMER_SUPPORTS_TICKLESS)
/**
*
- * _loApicTimerGetCount - get the value from the initial count register
+ * @brief Get the value from the initial count register
*
* This routine gets the value from the initial count register.
*
@@ -276,7 +276,7 @@
/**
*
- * _timer_int_handler - system clock tick handler
+ * @brief System clock tick handler
*
* This routine handles the system clock tick interrupt. A TICK_EVENT event
* is pushed onto the microkernel stack.
@@ -352,7 +352,7 @@
#if defined(TIMER_SUPPORTS_TICKLESS)
/**
*
- * _loApicTimerTicklessIdleInit - initialize the tickless idle feature
+ * @brief Initialize the tickless idle feature
*
* This routine initializes the tickless idle feature. Note that the maximum
* number of ticks that can elapse during a "tickless idle" is limited by
@@ -375,7 +375,7 @@
/**
*
- * _i8253TicklessIdleSkew - calculate the skew from idle mode switching
+ * @brief Calculate the skew from idle mode switching
*
* This routine calculates the skew from switching the timer in and out of idle
* mode. The typical sequence is:
@@ -409,7 +409,7 @@
/**
*
- * _timer_idle_enter - Place system timer into idle state
+ * @brief Place system timer into idle state
*
* Re-program the timer to enter into the idle state for the given number of
* ticks. It is placed into one shot mode where it will fire in the number of
@@ -462,7 +462,7 @@
/**
*
- * _timer_idle_exit - handling of tickless idle when interrupted
+ * @brief Handling of tickless idle when interrupted
*
* The routine is responsible for taking the timer out of idle mode and
* generating an interrupt at the next tick interval.
@@ -532,7 +532,7 @@
/**
*
- * timer_driver - initialize and enable the system clock
+ * @brief Initialize and enable the system clock
*
* This routine is used to program the PIT to deliver interrupts at the
* rate specified via the 'sys_clock_us_per_tick' global variable.
@@ -572,7 +572,7 @@
/**
*
- * timer_read - read the BSP timer hardware
+ * @brief Read the BSP timer hardware
*
* This routine returns the current time in terms of timer hardware clock cycles.
*
@@ -601,7 +601,7 @@
#if defined(CONFIG_SYSTEM_TIMER_DISABLE)
/**
*
- * timer_disable - stop announcing ticks into the kernel
+ * @brief Stop announcing ticks into the kernel
*
* This routine simply disables the LOAPIC counter such that interrupts are no
* longer delivered.
diff --git a/include/arch/arc/v2/arcv2_irq_unit.h b/include/arch/arc/v2/arcv2_irq_unit.h
index 4de0b3e..2bf945c 100644
--- a/include/arch/arc/v2/arcv2_irq_unit.h
+++ b/include/arch/arc/v2/arcv2_irq_unit.h
@@ -61,7 +61,7 @@
*/
/*
- * _arc_v2_irq_unit_irq_enable_set - enable/disable interrupt
+ * @brief Enable/disable interrupt
*
* Enables or disables the specified interrupt
*
@@ -78,7 +78,7 @@
}
/*
- * _arc_v2_irq_unit_int_enable - enable interrupt
+ * @brief Enable interrupt
*
* Enables the specified interrupt
*
@@ -91,7 +91,7 @@
}
/*
- * _arc_v2_irq_unit_int_disable - disable interrupt
+ * @brief Disable interrupt
*
* Disables the specified interrupt
*
@@ -104,7 +104,7 @@
}
/*
- * _arc_v2_irq_unit_prio_set - set interrupt priority
+ * @brief Set interrupt priority
*
* Set the priority of the specified interrupt
*
diff --git a/include/arch/arc/v2/ffs.h b/include/arch/arc/v2/ffs.h
index 1a41afe..c702f81 100644
--- a/include/arch/arc/v2/ffs.h
+++ b/include/arch/arc/v2/ffs.h
@@ -47,7 +47,7 @@
/**
*
- * nanoFfsMsb_inline - Find First Set bit (searching from most significant bit)
+ * @brief Find First Set bit (searching from most significant bit)
*
* This routine finds the first bit set in the argument passed it and returns
* the index of that bit. Bits are numbered starting at 1 from the least
@@ -76,7 +76,7 @@
/**
*
- * nanoFfsLsb - find first set bit (searching from the least significant bit)
+ * @brief Find first set bit (searching from the least significant bit)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
diff --git a/include/arch/arc/v2/irq.h b/include/arch/arc/v2/irq.h
index 383edd1..d220280 100644
--- a/include/arch/arc/v2/irq.h
+++ b/include/arch/arc/v2/irq.h
@@ -73,7 +73,7 @@
/**
*
- * irq_lock_inline - disable all interrupts on the CPU (inline)
+ * @brief Disable all interrupts on the CPU (inline)
*
* See irq_lock() for full description
*
@@ -93,7 +93,7 @@
/**
*
- * irq_unlock_inline - enable all interrupts on the CPU (inline)
+ * @brief Enable all interrupts on the CPU (inline)
*
* See irq_unlock() for full description
*
diff --git a/include/arch/arm/CortexM/asm_inline_gcc.h b/include/arch/arm/CortexM/asm_inline_gcc.h
index 110bc98..8cd3006 100644
--- a/include/arch/arm/CortexM/asm_inline_gcc.h
+++ b/include/arch/arm/CortexM/asm_inline_gcc.h
@@ -54,7 +54,7 @@
/**
*
- * find_last_set_inline - find first set bit (searching from most significant bit)
+ * @brief Find first set bit (searching from most significant bit)
*
* This routine finds the first bit set in the argument passed it and returns
* the index of that bit. Bits are numbered starting at 1 from the least
@@ -82,7 +82,7 @@
/**
*
- * find_first_set_inline - find first set bit (from the least significant bit)
+ * @brief Find first set bit (from the least significant bit)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
@@ -111,7 +111,7 @@
/**
*
- * irq_lock_inline - disable all interrupts on the CPU (inline)
+ * @brief Disable all interrupts on the CPU (inline)
*
* This routine disables interrupts. It can be called from either interrupt,
* task or fiber level. This routine returns an architecture-dependent
@@ -158,7 +158,7 @@
/**
*
- * irq_unlock_inline - enable all interrupts on the CPU (inline)
+ * @brief Enable all interrupts on the CPU (inline)
*
* This routine re-enables interrupts on the CPU. The <key> parameter
* is an architecture-dependent lock-out key that is returned by a previous
diff --git a/include/arch/arm/CortexM/irq.h b/include/arch/arm/CortexM/irq.h
index 6a957a3..e4be3fd 100644
--- a/include/arch/arm/CortexM/irq.h
+++ b/include/arch/arm/CortexM/irq.h
@@ -82,7 +82,7 @@
/**
*
- * IRQ_CONNECT_STATIC - connect a routine to interrupt number
+ * @brief Connect a routine to interrupt number
*
* For the device <device> associates IRQ number <irq> with priority
* <priority> with the interrupt routine <isr>, that receives parameter
@@ -99,7 +99,7 @@
/**
*
- * IRQ_CONFIG - configure interrupt for the device
+ * @brief Configure interrupt for the device
*
* For the given device do the neccessary configuration steps.
* Fpr ARM platform, set the interrupt priority
diff --git a/include/arch/arm/CortexM/nvic.h b/include/arch/arm/CortexM/nvic.h
index a9eacae..7d9c8f4 100644
--- a/include/arch/arm/CortexM/nvic.h
+++ b/include/arch/arm/CortexM/nvic.h
@@ -87,7 +87,7 @@
/**
*
- * _NvicIrqEnable - enable an IRQ
+ * @brief Enable an IRQ
*
* Enable IRQ #<irq>, which is equivalent to exception #<irq>+16
*
@@ -102,7 +102,7 @@
/**
*
- * _NvicIsIrqEnabled - find out if an IRQ is enabled
+ * @brief Find out if an IRQ is enabled
*
* Find out if IRQ #<irq> is enabled.
*
@@ -117,7 +117,7 @@
/**
*
- * _NvicIrqEnable - disable an IRQ
+ * @brief Disable an IRQ
*
* Disable IRQ #<irq>, which is equivalent to exception #<irq>+16
*
@@ -132,7 +132,7 @@
/**
*
- * _NvicIrqPend - pend an IRQ
+ * @brief Pend an IRQ
*
* Pend IRQ #<irq>, which is equivalent to exception #<irq>+16. CPU will handle
* the IRQ when interrupts are enabled and/or returning from a higher priority
@@ -149,7 +149,7 @@
/**
*
- * _NvicIsIrqPending - find out if an IRQ is pending
+ * @brief Find out if an IRQ is pending
*
* Find out if IRQ #<irq> is pending
*
@@ -164,7 +164,7 @@
/**
*
- * _NvicIrqUnpend - unpend an IRQ
+ * @brief Unpend an IRQ
*
* Unpend IRQ #<irq>, which is equivalent to exception #<irq>+16. The previously
* pending interrupt will be ignored when either unlocking interrupts or
@@ -181,7 +181,7 @@
/**
*
- * _NvicIrqPrioSet - set priority of an IRQ
+ * @brief Set priority of an IRQ
*
* Set priority of IRQ #<irq> to <prio>. There are 256 priority levels.
*
@@ -198,7 +198,7 @@
/**
*
- * _NvicIrqPrioGet - get priority of an IRQ
+ * @brief Get priority of an IRQ
*
* Get priority of IRQ #<irq>.
*
@@ -213,7 +213,7 @@
/**
*
- * _NvicSwInterruptTrigger - trigger an interrupt via software
+ * @brief Trigger an interrupt via software
*
* Trigger interrupt #<irq>. The CPU will handle the IRQ when interrupts are
* enabled and/or returning from a higher priority interrupt.
diff --git a/include/arch/arm/CortexM/scb.h b/include/arch/arm/CortexM/scb.h
index 6b27347..d59588b 100644
--- a/include/arch/arm/CortexM/scb.h
+++ b/include/arch/arm/CortexM/scb.h
@@ -75,7 +75,7 @@
/**
*
- * _ScbIsNmiPending - find out if the NMI exception is pending
+ * @brief Find out if the NMI exception is pending
*
* @return 1 if it is pending, 0 otherwise
*/
@@ -87,7 +87,7 @@
/**
*
- * _ScbNmiPend - pend the NMI exception
+ * @brief Pend the NMI exception
*
* Pend the NMI exception: it should fire immediately.
*
@@ -101,7 +101,7 @@
/**
*
- * _ScbIsPendsvPending - find out if the PendSV exception is pending
+ * @brief Find out if the PendSV exception is pending
*
* @return 1 if it is pending, 0 otherwise
*/
@@ -113,7 +113,7 @@
/**
*
- * _ScbPendsvSet - set the PendSV exception
+ * @brief Set the PendSV exception
*
* Set the PendSV exception: it will be handled when the last nested exception
* returns, or immediately if running in thread mode.
@@ -128,7 +128,7 @@
/**
*
- * _ScbPendsvClear - clear the PendSV exception
+ * @brief Clear the PendSV exception
*
* This routine clears the PendSV exception.
*
@@ -142,7 +142,7 @@
/**
*
- * _ScbIsSystickPending - find out if the SYSTICK exception is pending
+ * @brief Find out if the SYSTICK exception is pending
*
* This routine determines if the SYSTICK exception is pending.
*
@@ -156,7 +156,7 @@
/**
*
- * _ScbSystickPend - pend the SYSTICK exception
+ * @brief Pend the SYSTICK exception
*
* Pend the SYSTICK exception: it will be handled when returning from a higher
* priority exception or immediately if in thread mode or handling a lower
@@ -172,7 +172,7 @@
/**
*
- * _ScbSystickClear - clear the SYSTICK exception
+ * @brief Clear the SYSTICK exception
*
* This routine clears the SYSTICK exception.
*
@@ -186,7 +186,7 @@
/**
*
- * _ScbIsIrqPending - find out if an external interrupt is pending
+ * @brief Find out if an external interrupt is pending
*
* Find out if an external interrupt, generated by the NVIC, is pending.
*
@@ -200,7 +200,7 @@
/**
*
- * _ScbHiPriVectorPendingGet - find out the exception number of highest-priority
+ * @brief Find out the exception number of highest-priority
* pending exception (including interrupts)
*
* If one or more exceptions are pending, return the exception number of the
@@ -219,7 +219,7 @@
/**
*
- * _ScbIsNested - find out if the currently executing exception is nested
+ * @brief Find out if the currently executing exception is nested
*
* This routine determines if the currently executing exception is nested.
*
@@ -234,7 +234,7 @@
/**
*
- * _ScbIsInThreadMode - find out if running in thread mode
+ * @brief Find out if running in thread mode
*
* This routine determines if the current mode is thread mode.
*
@@ -249,7 +249,7 @@
/**
*
- * _ScbIsInHandlerMode - find out if running in handler mode
+ * @brief Find out if running in handler mode
*
* This routine determines if the current mode is handler mode.
*
@@ -263,7 +263,7 @@
/**
*
- * _ScbIsInExc - find out if handling an exception
+ * @brief Find out if handling an exception
*
* This routine determines if an exception is being handled (handler mode).
*
@@ -277,7 +277,7 @@
/**
*
- * _ScbActiveVectorGet - obtain the currently executing vector
+ * @brief Obtain the currently executing vector
*
* If currently handling an exception/interrupt, return the exceuting vector
* number. If not, return 0.
@@ -292,7 +292,7 @@
/**
*
- * _ScbIsVtableInSram - find out if vector table is in SRAM or ROM
+ * @brief Find out if vector table is in SRAM or ROM
*
* This routine determines if the currently executing exception is nested.
*
@@ -306,7 +306,7 @@
/**
*
- * _ScbVtableLocationSet - move vector table from SRAM to ROM and vice-versa
+ * @brief Move vector table from SRAM to ROM and vice-versa
*
* This routine moves the vector table to the given memory region.
*
@@ -323,7 +323,7 @@
/**
*
- * _ScbVtableAddrGet - obtain base address of vector table
+ * @brief Obtain base address of vector table
*
* This routine returs the vector table's base address.
*
@@ -337,7 +337,7 @@
/**
*
- * _ScbVtableAddrSet - set base address of vector table
+ * @brief Set base address of vector table
*
* <addr> must align to the number of exception entries in vector table:
*
@@ -363,7 +363,7 @@
/**
*
- * _ScbIsDataLittleEndian - find out if data regions are little endian
+ * @brief Find out if data regions are little endian
*
* Data regions on Cortex-M devices can be either little or big endian. Code
* regions are always little endian.
@@ -378,7 +378,7 @@
/**
*
- * _ScbNumPriGroupGet - get the programmed number of priority groups
+ * @brief Get the programmed number of priority groups
*
* Exception priorities can be sub-divided into groups, with sub-priorities.
* Within these groups, exceptions do not preempt each other. The sub-priorities
@@ -394,7 +394,7 @@
/**
*
- * _ScbSleepOnExitSet - CPU goes to sleep after exiting an ISR
+ * @brief CPU goes to sleep after exiting an ISR
*
* CPU never runs in thread mode until this is cancelled.
*
@@ -410,7 +410,7 @@
/**
*
- * _ScbSleepOnExitClear - CPU does not go to sleep after exiting an ISR
+ * @brief CPU does not go to sleep after exiting an ISR
*
* This routine prevents CPU sleep mode upon exiting an ISR.
* This is the normal operating mode.
@@ -425,7 +425,7 @@
/**
*
- * _ScbSevOnPendSet - do not put CPU to sleep if pending exception are present
+ * @brief Do not put CPU to sleep if pending exception are present
* when invoking wfe instruction
*
* By default, when invoking wfi or wfe instructions, if PRIMASK is masking
@@ -446,7 +446,7 @@
/**
*
- * _ScbSevOnPendClear - clear SEVONPEND bit
+ * @brief Clear SEVONPEND bit
*
* See _ScbSevOnPendSet().
*
@@ -460,7 +460,7 @@
/**
*
- * _ScbSleepDeepSet - when putting the CPU to sleep, put it in deep sleep
+ * @brief When putting the CPU to sleep, put it in deep sleep
*
* When wfi/wfe is invoked, the CPU will go into a "deep sleep" mode, using less
* power than regular sleep mode, but with some possible side-effect.
@@ -477,7 +477,7 @@
/**
*
- * _ScbSleepDeepSet - when putting the CPU to sleep, do not put it in deep sleep
+ * @brief When putting the CPU to sleep, do not put it in deep sleep
*
* This routine prevents CPU deep sleep mode.
*
@@ -491,7 +491,7 @@
/**
*
- * _ScbDivByZeroFaultEnable - enable faulting on division by zero
+ * @brief Enable faulting on division by zero
*
* This routine enables the divide by zero fault.
* By default, the CPU ignores the error.
@@ -506,7 +506,7 @@
/**
*
- * _ScbDivByZeroFaultDisable - ignore division by zero errors
+ * @brief Ignore division by zero errors
*
* This routine disables the divide by zero fault.
* This is the default behaviour.
@@ -521,7 +521,7 @@
/**
*
- * _ScbUnalignedFaultEnable - enable faulting on unaligned access
+ * @brief Enable faulting on unaligned access
*
* This routine enables the unaligned access fault.
* By default, the CPU ignores the error.
@@ -536,7 +536,7 @@
/**
*
- * _ScbUnalignedFaultDisable - ignore unaligned access errors
+ * @brief Ignore unaligned access errors
*
* This routine disables the divide by zero fault.
* This is the default behaviour.
@@ -551,7 +551,7 @@
/**
*
- * _ScbCcrSet - write the CCR all at once
+ * @brief Write the CCR all at once
*
* This routine writes the given value to the Configuration Control Register.
*
@@ -566,7 +566,7 @@
/**
*
- * _ScbExcPrioGet - obtain priority of an exception
+ * @brief Obtain priority of an exception
*
* Only works with exceptions 4 to 15, ie. do not use this for interrupts, which
* are exceptions 16+.
@@ -586,7 +586,7 @@
/**
*
- * _ScbExcPrioSet - set priority of an exception
+ * @brief Set priority of an exception
*
* Only works with exceptions 4 to 15, ie. do not use this for interrupts, which
* are exceptions 16+.
@@ -610,7 +610,7 @@
/**
*
- * _ScbUsageFaultEnable - enable usage fault exceptions
+ * @brief Enable usage fault exceptions
*
* This routine enables usage faults.
* By default, the CPU does not raise usage fault exceptions.
@@ -625,7 +625,7 @@
/**
*
- * _ScbUsageFaultDisable - disable usage fault exceptions
+ * @brief Disable usage fault exceptions
*
* This routine disables usage faults.
* This is the default behaviour.
@@ -640,7 +640,7 @@
/**
*
- * _ScbBusFaultEnable - enable bus fault exceptions
+ * @brief Enable bus fault exceptions
*
* This routine enables bus faults.
* By default, the CPU does not raise bus fault exceptions.
@@ -655,7 +655,7 @@
/**
*
- * _ScbBusFaultDisable - disable bus fault exceptions
+ * @brief Disable bus fault exceptions
*
* This routine disables bus faults.
* This is the default behaviour.
@@ -670,7 +670,7 @@
/**
*
- * _ScbMemFaultEnable - enable MPU faults exceptions
+ * @brief Enable MPU faults exceptions
*
* This routine enables the MPU faults.
* By default, the CPU does not raise MPU fault exceptions.
@@ -685,7 +685,7 @@
/**
*
- * _ScbMemFaultDisable - disable MPU fault exceptions
+ * @brief Disable MPU fault exceptions
*
* This routine disables MPU faults.
* This is the default behaviour.
@@ -700,7 +700,7 @@
/**
*
- * _ScbHardFaultIsBusErrOnVectorRead - find out if a hard fault is caused by
+ * @brief Find out if a hard fault is caused by
* a bus error on vector read
*
* This routine determines if a hard fault is caused by a bus error during
@@ -716,7 +716,7 @@
/**
*
- * _ScbHardFaultIsForced - find out if a fault was escalated to hard fault
+ * @brief Find out if a fault was escalated to hard fault
*
* Happens if a fault cannot be triggered because of priority or because it was
* disabled.
@@ -731,7 +731,7 @@
/**
*
- * _ScbHardFaultAllFaultsReset - clear all hard faults (HFSR register)
+ * @brief Clear all hard faults (HFSR register)
*
* HFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -745,7 +745,7 @@
/**
*
- * _ScbIsMemFault - find out if a hard fault is an MPU fault
+ * @brief Find out if a hard fault is an MPU fault
*
* This routine determines if a hard fault is an MPU fault.
*
@@ -759,7 +759,7 @@
/**
*
- * _ScbMemFaultIsMmfarValid - find out if the MMFAR register contains a valid
+ * @brief Find out if the MMFAR register contains a valid
* value
*
* The MMFAR register contains the faulting address on an MPU fault.
@@ -774,7 +774,7 @@
/**
*
- * _ScbMemFaultMmfarReset - invalid the value in MMFAR
+ * @brief Invalid the value in MMFAR
*
* This routine invalidates the MMFAR value. This should be done after
* processing an MPU fault.
@@ -789,7 +789,7 @@
/**
*
- * _ScbMemFaultAllFaultsReset - clear all MPU faults (MMFSR register)
+ * @brief Clear all MPU faults (MMFSR register)
*
* CFSR/MMFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -803,7 +803,7 @@
/**
*
- * _ScbMemFaultIsStacking - find out if an MPU fault is a stacking fault
+ * @brief Find out if an MPU fault is a stacking fault
*
* This routine determines if an MPU fault is a stacking fault.
* This may occur upon exception entry.
@@ -818,7 +818,7 @@
/**
*
- * _ScbMemFaultIsUnstacking - find out if an MPU fault is an unstacking fault
+ * @brief Find out if an MPU fault is an unstacking fault
*
* This routine determines if an MPU fault is an unstacking fault.
* This may occur upon exception exit.
@@ -833,7 +833,7 @@
/**
*
- * _ScbMemFaultIsDataAccessViolation - find out if an MPU fault is a data access
+ * @brief Find out if an MPU fault is a data access
* violation
*
* If this routine returns 1, read the MMFAR register via _ScbMemFaultAddrGet()
@@ -849,7 +849,7 @@
/**
*
- * _ScbMemFaultIsInstrAccessViolation - find out if an MPU fault is an
+ * @brief Find out if an MPU fault is an
* instruction access violation
*
* This routine determines if an MPU fault is due to an instruction access
@@ -865,7 +865,7 @@
/**
*
- * _ScbMemFaultAddrGet - find out the faulting address on an MPU fault
+ * @brief Find out the faulting address on an MPU fault
*
* @return the faulting address
*/
@@ -877,7 +877,7 @@
/**
*
- * _ScbIsBusFault - find out if a hard fault is a bus fault
+ * @brief Find out if a hard fault is a bus fault
*
* This routine determines if a hard fault is a bus fault.
*
@@ -891,7 +891,7 @@
/**
*
- * _ScbBusFaultIsBfarValid - find out if the BFAR register contains a valid
+ * @brief Find out if the BFAR register contains a valid
* value
*
* The BFAR register contains the faulting address on bus fault.
@@ -906,7 +906,7 @@
/**
*
- * _ScbMemFaultBfarReset - invalid the value in BFAR
+ * @brief Invalid the value in BFAR
*
* This routine clears/invalidates the Bus Fault Address Register.
* It should be done after processing a bus fault.
@@ -921,7 +921,7 @@
/**
*
- * _ScbBusFaultAllFaultsReset - clear all bus faults (BFSR register)
+ * @brief Clear all bus faults (BFSR register)
*
* CFSR/BFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -935,7 +935,7 @@
/**
*
- * _ScbBusFaultIsStacking - find out if a bus fault is a stacking fault
+ * @brief Find out if a bus fault is a stacking fault
*
* This routine determines if a bus fault is a stacking fault.
* This may occurs upon exception entry.
@@ -950,7 +950,7 @@
/**
*
- * _ScbBusFaultIsUnstacking - find out if a bus fault is an unstacking fault
+ * @brief Find out if a bus fault is an unstacking fault
*
* This routine determines if a bus fault is an unstacking fault.
* This may occur upon exception exit.
@@ -965,7 +965,7 @@
/**
*
- * _ScbBusFaultIsImprecise - find out if a bus fault is an imprecise error
+ * @brief Find out if a bus fault is an imprecise error
*
* This routine determines if a bus fault is an imprecise error.
*
@@ -979,7 +979,7 @@
/**
*
- * _ScbBusFaultIsPrecise - find out if a bus fault is an precise error
+ * @brief Find out if a bus fault is an precise error
*
* Read the BFAR register via _ScbBusFaultAddrGet() if this routine returns 1,
* as it will contain the faulting address.
@@ -994,7 +994,7 @@
/**
*
- * _ScbBusFaultIsInstrBusErr - find out if a bus fault is an instruction bus
+ * @brief Find out if a bus fault is an instruction bus
* error
*
* This routine determines if a bus fault is an instruction bus error.
@@ -1010,7 +1010,7 @@
/**
*
- * _ScbBusFaultAddrGet - get the faulting address on a precise bus fault
+ * @brief Get the faulting address on a precise bus fault
*
* This routine returns the faulting address for a precise bus fault.
*
@@ -1024,7 +1024,7 @@
/**
*
- * _ScbIsUsageFault - find out if a hard fault is a usage fault
+ * @brief Find out if a hard fault is a usage fault
*
* This routine determines if a hard fault is a usage fault.
*
@@ -1038,7 +1038,7 @@
/**
*
- * _ScbUsageFaultIsDivByZero - find out if a usage fault is a 'divide by zero'
+ * @brief Find out if a usage fault is a 'divide by zero'
* fault
*
* This routine determines if a usage fault is a 'divde by zero' fault.
@@ -1053,7 +1053,7 @@
/**
*
- * _ScbUsageFaultIsUnaligned - find out if a usage fault is a unaligned access
+ * @brief Find out if a usage fault is a unaligned access
* error
*
* This routine determines if a usage fault is an unaligned access error.
@@ -1068,7 +1068,7 @@
/**
*
- * _ScbUsageFaultIsNoCp - find out if a usage fault is a coprocessor access
+ * @brief Find out if a usage fault is a coprocessor access
* error
*
* This routine determines if a usage fault is caused by a coprocessor access.
@@ -1084,7 +1084,7 @@
/**
*
- * _ScbUsageFaultIsInvalidPcLoad - find out if a usage fault is a invalid PC
+ * @brief Find out if a usage fault is a invalid PC
* load error
*
* Happens if the the instruction address on an exception return is not
@@ -1100,7 +1100,7 @@
/**
*
- * _ScbUsageFaultIsInvalidState - find out if a usage fault is a invalid state
+ * @brief Find out if a usage fault is a invalid state
* error
*
* Happens if the the instruction address loaded in the PC via a branch, LDR or
@@ -1117,7 +1117,7 @@
/**
*
- * _ScbUsageFaultIsUndefinedInstr - find out if a usage fault is a undefined
+ * @brief Find out if a usage fault is a undefined
* instruction error
*
* The processor tried to execute an invalid opcode.
@@ -1132,7 +1132,7 @@
/**
*
- * _ScbUsageFaultDivByZeroReset - clear the 'division by zero' fault
+ * @brief Clear the 'division by zero' fault
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -1146,7 +1146,7 @@
/**
*
- * _ScbUsageFaultUnalignedReset - clear the 'unaligned access' fault
+ * @brief Clear the 'unaligned access' fault
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -1160,7 +1160,7 @@
/**
*
- * _ScbUsageFaultNoCpReset - clear the 'no co-processor' fault
+ * @brief Clear the 'no co-processor' fault
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -1174,7 +1174,7 @@
/**
*
- * _ScbUsageFaultInvalidPcLoadReset - clear the 'invalid PC load ' fault
+ * @brief Clear the 'invalid PC load ' fault
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -1188,7 +1188,7 @@
/**
*
- * _ScbUsageFaultInvalidStateReset - clear the 'invalid state' fault
+ * @brief Clear the 'invalid state' fault
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -1202,7 +1202,7 @@
/**
*
- * _ScbUsageFaultUndefinedInstrReset - clear the 'undefined instruction' fault
+ * @brief Clear the 'undefined instruction' fault
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
@@ -1216,7 +1216,7 @@
/**
*
- * _ScbUsageFaultAllFaultsReset - clear all usage faults (UFSR register)
+ * @brief Clear all usage faults (UFSR register)
*
* CFSR/UFSR register is a 'write-one-to-clear' (W1C) register.
*
diff --git a/include/arch/arm/CortexM/scs.h b/include/arch/arm/CortexM/scs.h
index 9c60ed8..602182d 100644
--- a/include/arch/arm/CortexM/scs.h
+++ b/include/arch/arm/CortexM/scs.h
@@ -433,7 +433,7 @@
/**
*
- * _ScsNumIrqGet - obtain the number of interrupt lines on the target
+ * @brief Obtain the number of interrupt lines on the target
*
* @return the number of interrupts
*/
@@ -445,7 +445,7 @@
/**
*
- * _ScsIntMultiCycleInstDisable - disable load/store multiple instructions
+ * @brief Disable load/store multiple instructions
*
* From the ARM manuals:
*
@@ -463,7 +463,7 @@
/**
*
- * _ScsIntMultiCycleInstEnable - enable load/store multiple instructions
+ * @brief Enable load/store multiple instructions
*
* See _ScsIntMultiCycleInstDisable().
*
@@ -477,7 +477,7 @@
/**
*
- * _ScsWriteBufDisable - disable write buffer
+ * @brief Disable write buffer
*
* From the ARM manuals:
*
@@ -495,7 +495,7 @@
/**
*
- * _ScsWriteBufEnable - enable write buffer
+ * @brief Enable write buffer
*
* See _ScsWriteBufDisable().
*
@@ -509,7 +509,7 @@
/**
*
- * _ScsFoldItDisable - disable IT folding
+ * @brief Disable IT folding
*
* From the ARM manuals:
*
@@ -529,7 +529,7 @@
/**
*
- * _ScsFoldItEnable - enable IT folding
+ * @brief Enable IT folding
*
* See _ScsFoldItDisable().
*
diff --git a/include/arch/x86/arch.h b/include/arch/x86/arch.h
index c36e8b3..8febc50 100644
--- a/include/arch/x86/arch.h
+++ b/include/arch/x86/arch.h
@@ -107,7 +107,7 @@
/**
*
- * NANO_CPU_INT_REGISTER - connect a routine to an interrupt vector
+ * @brief Connect a routine to an interrupt vector
*
* This macro "connects" the specified routine, <r>, to the specified interrupt
* vector, <v> using the descriptor privilege level <d>. On the IA-32
@@ -140,7 +140,7 @@
/**
*
- * IRQ_CONNECT_STATIC - connect a routine to interrupt number
+ * @brief Connect a routine to interrupt number
*
* For the device <device> associates IRQ number <irq> with priority
* <priority> with the interrupt routine <isr>, that receives parameter
@@ -157,7 +157,7 @@
/**
*
- * IRQ_CONFIG - configure interrupt for the device
+ * @brief Configure interrupt for the device
*
* For the given device do the neccessary configuration steps.
* For x86 platform configure APIC and mark interrupt vector allocated
@@ -276,7 +276,7 @@
/**
*
- * irq_lock_inline - disable all interrupts on the CPU (inline)
+ * @brief Disable all interrupts on the CPU (inline)
*
* This routine disables interrupts. It can be called from either interrupt,
* task or fiber level. This routine returns an architecture-dependent
@@ -320,7 +320,7 @@
/**
*
- * irq_unlock_inline - enable all interrupts on the CPU (inline)
+ * @brief Enable all interrupts on the CPU (inline)
*
* This routine re-enables interrupts on the CPU. The <key> parameter
* is an architecture-dependent lock-out key that is returned by a previous
diff --git a/include/arch/x86/asm_inline_gcc.h b/include/arch/x86/asm_inline_gcc.h
index 9ce3545..4633bc6 100644
--- a/include/arch/x86/asm_inline_gcc.h
+++ b/include/arch/x86/asm_inline_gcc.h
@@ -46,7 +46,7 @@
/**
*
- * _do_irq_lock_inline - disable all interrupts on the CPU (inline)
+ * @brief Disable all interrupts on the CPU (inline)
*
* This routine disables interrupts. It can be called from either interrupt,
* task or fiber level. This routine returns an architecture-dependent
@@ -95,7 +95,7 @@
/**
*
- * _do_irq_unlock_inline - enable all interrupts on the CPU (inline)
+ * @brief Enable all interrupts on the CPU (inline)
*
* This routine can be called from either interrupt, task or fiber level.
* Invoked by kernel or by irq_unlock_inline()
@@ -117,7 +117,7 @@
/**
*
- * find_first_set_inline - find first set bit searching from the LSB (inline)
+ * @brief Find first set bit searching from the LSB (inline)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
@@ -168,7 +168,7 @@
/**
*
- * find_last_set_inline - find first set bit searching from the MSB (inline)
+ * @brief Find first set bit searching from the MSB (inline)
*
* This routine finds the first bit set in the argument passed it and
* returns the index of that bit. Bits are numbered starting
@@ -252,7 +252,7 @@
/**
*
- * _do_read_cpu_timestamp - get a 32 bit CPU timestamp counter
+ * @brief Get a 32 bit CPU timestamp counter
*
* @return a 32-bit number
*/
@@ -270,7 +270,7 @@
/**
*
- * sys_out8 - output a byte to an IA-32 I/O port
+ * @brief Output a byte to an IA-32 I/O port
*
* This function issues the 'out' instruction to write a byte to the specified
* I/O port.
@@ -289,7 +289,7 @@
/**
*
- * sys_in8 - input a byte from an IA-32 I/O port
+ * @brief Input a byte from an IA-32 I/O port
*
* This function issues the 'in' instruction to read a byte from the specified
* I/O port.
@@ -311,7 +311,7 @@
/**
*
- * sys_out16 - output a word to an IA-32 I/O port
+ * @brief Output a word to an IA-32 I/O port
*
* This function issues the 'out' instruction to write a word to the
* specified I/O port.
@@ -330,7 +330,7 @@
/**
*
- * sys_in16 - input a word from an IA-32 I/O port
+ * @brief Input a word from an IA-32 I/O port
*
* This function issues the 'in' instruction to read a word from the
* specified I/O port.
@@ -352,7 +352,7 @@
/**
*
- * sys_out32 - output a long word to an IA-32 I/O port
+ * @brief Output a long word to an IA-32 I/O port
*
* This function issues the 'out' instruction to write a long word to the
* specified I/O port.
@@ -371,7 +371,7 @@
/**
*
- * sys_in32 - input a long word from an IA-32 I/O port
+ * @brief Input a long word from an IA-32 I/O port
*
* This function issues the 'in' instruction to read a long word from the
* specified I/O port.
diff --git a/include/drivers/k20_watchdog.h b/include/drivers/k20_watchdog.h
index 3b2e0ac..bca089f 100644
--- a/include/drivers/k20_watchdog.h
+++ b/include/drivers/k20_watchdog.h
@@ -93,7 +93,7 @@
/**
*
- * wdog_unlock - Watchdog timer unlock routine.
+ * @brief Watchdog timer unlock routine.
*
* This routine will unlock the watchdog timer registers for write access.
* Writing 0xC520 followed by 0xD928 will unlock the write-once registers
@@ -126,7 +126,7 @@
/**
*
- * wdog_disable - Watchdog timer disable routine
+ * @brief Watchdog timer disable routine
*
* This routine will disable the watchdog timer.
*
diff --git a/include/microkernel/command_packet.h b/include/microkernel/command_packet.h
index 0b0d7fb..d51324a 100644
--- a/include/microkernel/command_packet.h
+++ b/include/microkernel/command_packet.h
@@ -45,7 +45,7 @@
/**
*
- * CMD_PKT_SET_INSTANCE - define an instance of a command packet set
+ * @brief Define an instance of a command packet set
*
* This macro is used to create an instance of a command packet set in the
* global namespace. Each instance of the set may have its own unique number
@@ -62,7 +62,7 @@
/**
*
- * CMD_PKT_SET - wrapper for accessing a command packet set
+ * @brief Wrapper for accessing a command packet set
*
* As a command packet set is instantiated as an array of uint32_t, it is
* necessary to typecast a command packet set before accessing it.
diff --git a/kernel/microkernel/k_command_packet.c b/kernel/microkernel/k_command_packet.c
index 603d3f5..b8d86d1 100644
--- a/kernel/microkernel/k_command_packet.c
+++ b/kernel/microkernel/k_command_packet.c
@@ -69,7 +69,7 @@
/**
*
- * _cmd_pkt_get - get the next command packet
+ * @brief Get the next command packet
*
* This routine gets the next command packet from the specified set.
*
@@ -95,7 +95,7 @@
/**
*
- * _k_task_call - send command packet to be processed by K_swapper
+ * @brief Send command packet to be processed by K_swapper
*
* @return N/A
*/
diff --git a/kernel/microkernel/k_event.c b/kernel/microkernel/k_event.c
index b48affb..82a25cc 100644
--- a/kernel/microkernel/k_event.c
+++ b/kernel/microkernel/k_event.c
@@ -39,7 +39,7 @@
/**
*
- * _k_event_handler_set - perform set event handler request
+ * @brief Perform set event handler request
*
* @return N/A
*/
@@ -73,7 +73,7 @@
/**
*
- * task_event_set_handler - set event handler request
+ * @brief Set event handler request
*
* This routine specifies the event handler that runs (in the context of the
* K_swapper fiber) when the associated event is signaled. Specifying a non-NULL
@@ -103,7 +103,7 @@
/**
*
- * _k_event_test_timeout - finish handling a test for event request that timed out
+ * @brief Finish handling a test for event request that timed out
*
* @return N/A
*/
@@ -121,7 +121,7 @@
/**
*
- * _k_event_test - perform test for event request
+ * @brief Perform test for event request
*
* @return N/A
*/
@@ -168,7 +168,7 @@
/**
*
- * _task_event_recv - test for event request
+ * @brief Test for event request
*
* This routine tests an event to see if it has been signaled.
*
@@ -191,7 +191,7 @@
/**
*
- * _k_do_event_signal - signal an event
+ * @brief Signal an event
*
* Lowest level event signalling routine, which is invoked directly when the
* signal is issued by a task and indirectly when the signal is issued by a
@@ -235,7 +235,7 @@
/**
*
- * _k_event_signal - perform signal an event request
+ * @brief Perform signal an event request
*
* @return N/A
*/
@@ -254,7 +254,7 @@
/**
*
- * task_event_send - signal an event request
+ * @brief Signal an event request
*
* This routine signals the specified event from a task. If an event handler
* is installed for that event, it will run; if no event handler is installed,
@@ -276,7 +276,7 @@
/**
*
- * fiber_event_send - signal an event from a fiber
+ * @brief Signal an event from a fiber
*
* This routine does NOT validate the specified event number.
*
@@ -287,7 +287,7 @@
/**
*
- * isr_event_send - signal an event from an ISR
+ * @brief Signal an event from an ISR
*
* This routine does NOT validate the specified event number.
*
diff --git a/kernel/microkernel/k_fifo.c b/kernel/microkernel/k_fifo.c
index 2e0aa51..b77725b 100644
--- a/kernel/microkernel/k_fifo.c
+++ b/kernel/microkernel/k_fifo.c
@@ -37,7 +37,7 @@
/**
*
- * _k_fifo_enque_reply - finish performing an incomplete FIFO enqueue request
+ * @brief Finish performing an incomplete FIFO enqueue request
*
* @return N/A
*/
@@ -62,7 +62,7 @@
/**
*
- * _k_fifo_enque_request - perform a FIFO enqueue request
+ * @brief Perform a FIFO enqueue request
*
* @return N/A
*/
@@ -138,7 +138,7 @@
}
/**
*
- * _task_fifo_put - FIFO enqueue request
+ * @brief FIFO enqueue request
*
* This routine puts an entry at the end of the FIFO queue.
*
@@ -164,7 +164,7 @@
/**
*
- * _k_fifo_deque_reply - finish performing an incomplete FIFO dequeue request
+ * @brief Finish performing an incomplete FIFO dequeue request
*
* @return N/A
*/
@@ -189,7 +189,7 @@
/**
*
- * _k_fifo_deque_request - perform FIFO dequeue request
+ * @brief Perform FIFO dequeue request
*
* @return N/A
*/
@@ -268,7 +268,7 @@
/**
*
- * _task_fifo_get - FIFO dequeue request
+ * @brief FIFO dequeue request
*
* This routine tries to read a data element from the FIFO.
*
@@ -297,7 +297,7 @@
/**
*
- * _k_fifo_ioctl - perform miscellaneous FIFO request
+ * @brief Perform miscellaneous FIFO request
*
* @return N/A
*/
@@ -337,7 +337,7 @@
/**
*
- * _task_fifo_ioctl - miscellaneous FIFO request
+ * @brief Miscellaneous FIFO request
*
* Depending upon the chosen operation, this routine will ...
* 1. <op> = 0 : query the number of FIFO entries
diff --git a/kernel/microkernel/k_idle.c b/kernel/microkernel/k_idle.c
index 8cb437f..4745486 100644
--- a/kernel/microkernel/k_idle.c
+++ b/kernel/microkernel/k_idle.c
@@ -68,7 +68,7 @@
/**
*
- * workload_loop - shared code between workload calibration and monitoring
+ * @brief Shared code between workload calibration and monitoring
*
* Perform idle task "dummy work".
*
@@ -102,7 +102,7 @@
/**
*
- * _k_workload_monitor_calibrate - calibrate the workload monitoring subsystem
+ * @brief Calibrate the workload monitoring subsystem
*
* Measures the time required to do a fixed amount of "dummy work", and
* sets default values for the workload measuring period.
@@ -135,7 +135,7 @@
/**
*
- * _k_workload_monitor_update - workload monitor tick handler
+ * @brief Workload monitor tick handler
*
* If workload monitor is configured this routine updates the global variables
* it uses to record the passage of time.
@@ -158,7 +158,7 @@
/**
*
- * _k_workload_monitor_idle_start - workload monitor "start idling" handler
+ * @brief Workload monitor "start idling" handler
*
* Records time when idle task was selected for execution by the microkernel.
*
@@ -172,7 +172,7 @@
/**
*
- * _k_workload_monitor_idle_end - workload monitor "end idling" handler
+ * @brief Workload monitor "end idling" handler
*
* Records time when idle task was no longer selected for execution by the
* microkernel, and updates amount of time spent idling.
@@ -189,7 +189,7 @@
/**
*
- * _k_workload_get - process request to read the processor workload
+ * @brief Process request to read the processor workload
*
* Computes workload, or uses 0 if workload monitoring is not configured.
*
@@ -231,7 +231,7 @@
/**
*
- * task_workload_get - read the processor workload
+ * @brief Read the processor workload
*
* This routine returns the workload as a number ranging from 0 to 1000.
*
@@ -257,7 +257,7 @@
/**
*
- * sys_workload_time_slice_set - set workload period
+ * @brief Set workload period
*
* This routine specifies the workload measuring period for task_workload_get().
*
@@ -305,7 +305,7 @@
/**
*
- * _sys_power_save_idle - power management policy when kernel begins idling
+ * @brief Power management policy when kernel begins idling
*
* This routine implements the power management policy based on the time
* until the timer expires, in system ticks.
@@ -350,7 +350,7 @@
/**
*
- * _sys_power_save_idle_exit - power management policy when kernel stops idling
+ * @brief Power management policy when kernel stops idling
*
* This routine is invoked when the kernel leaves the idle state.
* Routine can be modified to wake up other devices.
@@ -376,7 +376,7 @@
/**
*
- * _get_next_timer_expiry - obtain number of ticks until next timer expires
+ * @brief Obtain number of ticks until next timer expires
*
* Must be called with interrupts locked to prevent the timer queues from
* changing.
@@ -399,7 +399,7 @@
/**
*
- * _power_save - power saving when idle
+ * @brief Power saving when idle
*
* If the BSP sets the _sys_power_save_flag flag, this routine will call the
* _sys_power_save_idle() routine in an infinite loop. If the flag is not set,
@@ -449,7 +449,7 @@
/**
*
- * _k_kernel_idle - microkernel idle task
+ * @brief Microkernel idle task
*
* If power save is on, we sleep; if power save is off, we "busy wait".
*
diff --git a/kernel/microkernel/k_irq.c b/kernel/microkernel/k_irq.c
index b764462..3870048 100644
--- a/kernel/microkernel/k_irq.c
+++ b/kernel/microkernel/k_irq.c
@@ -104,7 +104,7 @@
/**
*
- * task_irq_int_handler - ISR for task IRQ objects
+ * @brief ISR for task IRQ objects
*
* This ISR handles interrupts generated by registered task IRQ objects.
*
@@ -131,7 +131,7 @@
/**
*
- * task_irq_free - free a task IRQ object
+ * @brief Free a task IRQ object
*
* The task IRQ object's interrupt is disabled, and the associated event
* is flushed; the object's interrupt vector is then freed, and the object's
@@ -155,7 +155,7 @@
/**
*
- * task_irq_ack - re-enable a task IRQ object's interrupt
+ * @brief Re-enable a task IRQ object's interrupt
*
* This re-enables the interrupt for a task IRQ object.
*
@@ -174,7 +174,7 @@
/**
*
- * _task_irq_test - determine if a task IRQ object has had an interrupt
+ * @brief Determine if a task IRQ object has had an interrupt
*
* This tests a task IRQ object to see if it has signalled an interrupt.
*
@@ -194,7 +194,7 @@
/**
*
- * _k_task_irq_alloc - allocate a task IRQ object
+ * @brief Allocate a task IRQ object
*
* This routine allocates a task IRQ object to a task.
*
@@ -237,7 +237,7 @@
/**
*
- * task_irq_alloc - register a task IRQ object
+ * @brief Register a task IRQ object
*
* This routine connects a task IRQ object to a system interrupt based
* upon the specified IRQ and priority values.
diff --git a/kernel/microkernel/k_mailbox.c b/kernel/microkernel/k_mailbox.c
index 8b7cc3b..84517d5 100644
--- a/kernel/microkernel/k_mailbox.c
+++ b/kernel/microkernel/k_mailbox.c
@@ -42,7 +42,7 @@
/**
*
- * ISASYNCMSG - determines if mailbox message is synchronous or asynchronous
+ * @brief Determines if mailbox message is synchronous or asynchronous
*
* Returns a non-zero value if the specified message contains a valid pool ID,
* indicating that it is an asynchronous message.
@@ -52,7 +52,7 @@
/**
*
- * copy_packet - copy a packet
+ * @brief Copy a packet
*
* @return N/A
*/
@@ -72,7 +72,7 @@
/**
*
- * match - determine if there is a match between the mailbox sender and receiver
+ * @brief Determine if there is a match between the mailbox sender and receiver
*
* @return matched message size, or -1 if no match
*/
@@ -228,7 +228,7 @@
/**
*
- * _k_mbox_send_ack - process the acknowledgment to a mailbox send request
+ * @brief Process the acknowledgment to a mailbox send request
*
* @return N/A
*/
@@ -300,7 +300,7 @@
/**
*
- * _k_mbox_send_reply - process the timeout for a mailbox send request
+ * @brief Process the timeout for a mailbox send request
*
* @return N/A
*/
@@ -316,7 +316,7 @@
/**
*
- * _k_mbox_send_request - process a mailbox send request
+ * @brief Process a mailbox send request
*
* @return N/A
*/
@@ -476,7 +476,7 @@
/**
*
- * _task_mbox_put - send a message to a mailbox
+ * @brief Send a message to a mailbox
*
* This routine sends a message to a mailbox and looks for a matching receiver.
*
@@ -517,7 +517,7 @@
/**
*
- * _k_mbox_receive_ack - process a mailbox receive acknowledgment
+ * @brief Process a mailbox receive acknowledgment
*
* This routine processes a mailbox receive acknowledgment.
*
@@ -547,7 +547,7 @@
/**
*
- * _k_mbox_receive_reply - process the timeout for a mailbox receive request
+ * @brief Process the timeout for a mailbox receive request
*
* @return N/A
*/
@@ -565,7 +565,7 @@
/**
*
- * _k_mbox_receive_request - process a mailbox receive request
+ * @brief Process a mailbox receive request
*
* @return N/A
*/
@@ -692,7 +692,7 @@
/**
*
- * _task_mbox_get - gets struct k_msg message header structure information
+ * @brief Gets struct k_msg message header structure information
* from a mailbox
*
* @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively
@@ -726,7 +726,7 @@
/**
*
- * _task_mbox_put_async - send a message asynchronously to a mailbox
+ * @brief Send a message asynchronously to a mailbox
*
* This routine sends a message to a mailbox and does not wait for a matching
* receiver. There is no exchange header returned to the sender. When the data
@@ -769,7 +769,7 @@
/**
*
- * _k_mbox_receive_data - process a mailbox receive data request
+ * @brief Process a mailbox receive data request
*
* @return N/A
*/
@@ -814,7 +814,7 @@
/**
*
- * _task_mbox_data_get - get message data
+ * @brief Get message data
*
* This routine is called for either of the two following purposes:
* 1. To transfer data if the call to task_mbox_get() resulted in a non-zero size
@@ -847,7 +847,7 @@
/**
*
- * _task_mbox_data_get_async_block - get the mailbox data and place
+ * @brief Get the mailbox data and place
* in a memory pool block
*
* @return RC_OK upon success, RC_FAIL upon failure, or RC_TIME upon timeout
@@ -946,7 +946,7 @@
/**
*
- * _k_mbox_send_data - process a mailbox send data request
+ * @brief Process a mailbox send data request
*
* @return N/A
*/
diff --git a/kernel/microkernel/k_memory_map.c b/kernel/microkernel/k_memory_map.c
index 82d77a5..0044bb3 100644
--- a/kernel/microkernel/k_memory_map.c
+++ b/kernel/microkernel/k_memory_map.c
@@ -35,7 +35,7 @@
/**
*
- * _k_mem_map_init - initialize kernel memory map subsystem
+ * @brief Initialize kernel memory map subsystem
*
* Perform any initialization of memory maps that wasn't done at build time.
*
@@ -72,7 +72,7 @@
/**
*
- * _k_mem_map_alloc_timeout - finish handling a memory map block request that timed out
+ * @brief Finish handling a memory map block request that timed out
*
* @return N/A
*/
@@ -87,7 +87,7 @@
/**
*
- * _k_mem_map_alloc - perform allocate memory map block request
+ * @brief Perform allocate memory map block request
*
* @return N/A
*/
@@ -132,7 +132,7 @@
/**
*
- * _task_mem_map_alloc - allocate memory map block request
+ * @brief Allocate memory map block request
*
* This routine is used to request a block of memory from the memory map.
*
@@ -156,7 +156,7 @@
/**
*
- * _k_mem_map_dealloc - perform return memory map block request
+ * @brief Perform return memory map block request
*
* @return N/A
*/
@@ -196,7 +196,7 @@
/**
*
- * _task_mem_map_free - return memory map block request
+ * @brief Return memory map block request
*
* This routine returns a block to the specified memory map. If a higher
* priority task is waiting for a block from the same map a task switch
@@ -219,7 +219,7 @@
/**
*
- * task_mem_map_used_get - read the number of used blocks in a memory map
+ * @brief Read the number of used blocks in a memory map
*
* This routine returns the number of blocks in use for the memory map.
*
diff --git a/kernel/microkernel/k_memory_pool.c b/kernel/microkernel/k_memory_pool.c
index 2c3007d..3f4fb90 100644
--- a/kernel/microkernel/k_memory_pool.c
+++ b/kernel/microkernel/k_memory_pool.c
@@ -45,7 +45,7 @@
/**
*
- * _k_mem_pool_init - initialize kernel memory pool subsystem
+ * @brief Initialize kernel memory pool subsystem
*
* Perform any initialization of memory pool that wasn't done at build time.
*
@@ -101,7 +101,7 @@
/**
*
- * search_bp - ???
+ * @brief ???
*
* marks ptr as free block in the given list [MYSTERIOUS LEGACY COMMENT]
*
@@ -136,7 +136,7 @@
/**
*
- * defrag - defragmentation algorithm for memory pool
+ * @brief Defragmentation algorithm for memory pool
*
* @return N/A
*/
@@ -192,7 +192,7 @@
/**
*
- * _k_defrag - perform defragment memory pool request
+ * @brief Perform defragment memory pool request
*
* @return N/A
*/
@@ -225,7 +225,7 @@
/**
*
- * task_mem_pool_defragment - defragment memory pool request
+ * @brief Defragment memory pool request
*
* This routine concatenates unused memory in a memory pool.
*
@@ -244,7 +244,7 @@
/**
*
- * search_block_on_frag_level - allocate block using specified fragmentation level
+ * @brief Allocate block using specified fragmentation level
*
* This routine attempts to allocate a free block. [NEED TO EXPAND THIS]
*
@@ -326,7 +326,7 @@
/**
*
- * get_block_recusive - recursively get a block, doing fragmentation if necessary
+ * @brief Recursively get a block, doing fragmentation if necessary
*
* [NEED A BETTER DESCRIPTION HERE]
*
@@ -410,7 +410,7 @@
/**
*
- * _k_block_waiters_get - examine tasks that are waiting for memory pool blocks
+ * @brief Examine tasks that are waiting for memory pool blocks
*
* This routine attempts to satisfy any incomplete block allocation requests for
* the specified memory pool. It can be invoked either by the explicit freeing
@@ -480,7 +480,7 @@
/**
*
- * _k_mem_pool_block_get_timeout_handle - finish handling an allocate block request that timed out
+ * @brief Finish handling an allocate block request that timed out
*
* @return N/A
*/
@@ -495,7 +495,7 @@
/**
*
- * _k_mem_pool_block_get - perform allocate memory pool block request
+ * @brief Perform allocate memory pool block request
*
* @return N/A
*/
@@ -557,7 +557,7 @@
/**
*
- * _task_mem_pool_alloc - allocate memory pool block request
+ * @brief Allocate memory pool block request
*
* This routine allocates a free block from the specified memory pool, ensuring
* that its size is at least as big as the size requested (in bytes).
@@ -591,7 +591,7 @@
/**
*
- * _k_mem_pool_block_release - perform return memory pool block request
+ * @brief Perform return memory pool block request
*
* Marks a block belonging to a pool as free; if there are waiters that can use
* the the block it is passed to a waiting task.
@@ -661,7 +661,7 @@
/**
*
- * task_mem_pool_free - return memory pool block request
+ * @brief Return memory pool block request
*
* This routine returns a block to a memory pool.
*
diff --git a/kernel/microkernel/k_move_data.c b/kernel/microkernel/k_move_data.c
index f033d4b..35f7c5c 100644
--- a/kernel/microkernel/k_move_data.c
+++ b/kernel/microkernel/k_move_data.c
@@ -56,7 +56,7 @@
/**
*
- * mvdreq_copy - perform movedata request
+ * @brief Perform movedata request
*
* @return N/A
*/
@@ -74,7 +74,7 @@
/**
*
- * _k_movedata_request - process a movedata request
+ * @brief Process a movedata request
*
* @return N/A
*/
diff --git a/kernel/microkernel/k_mutex.c b/kernel/microkernel/k_mutex.c
index cf0bc0a..9f651e2 100644
--- a/kernel/microkernel/k_mutex.c
+++ b/kernel/microkernel/k_mutex.c
@@ -61,7 +61,7 @@
/**
*
- * _k_mutex_lock_reply - reply to a mutex lock request (LOCK_TMO, LOCK_RPL)
+ * @brief Reply to a mutex lock request (LOCK_TMO, LOCK_RPL)
*
* This routine replies to a mutex lock request. This will occur if either
* the waiting task times out or acquires the mutex lock.
@@ -146,7 +146,7 @@
/**
*
- * _k_mutex_lock_request - process a mutex lock request
+ * @brief Process a mutex lock request
*
* This routine processes a mutex lock request (LOCK_REQ). If the mutex
* is already locked, and the timeout is non-zero then the priority inheritance
@@ -269,7 +269,7 @@
/**
*
- * _task_mutex_lock - mutex lock kernel service
+ * @brief Mutex lock kernel service
*
* This routine is the entry to the mutex lock kernel service.
*
@@ -293,7 +293,7 @@
/**
*
- * _k_mutex_unlock - process a mutex unlock request
+ * @brief Process a mutex unlock request
*
* This routine processes a mutex unlock request (UNLOCK). If the mutex
* was involved in priority inheritance, then it will change the priority level
@@ -387,7 +387,7 @@
/**
*
- * _task_mutex_unlock - mutex unlock kernel service
+ * @brief Mutex unlock kernel service
*
* This routine is the entry to the mutex unlock kernel service.
*
diff --git a/kernel/microkernel/k_nop.c b/kernel/microkernel/k_nop.c
index 7ea2ca6..4ecc695 100644
--- a/kernel/microkernel/k_nop.c
+++ b/kernel/microkernel/k_nop.c
@@ -46,7 +46,7 @@
/**
*
- * _k_nop - perform "do nothing" kernel request
+ * @brief Perform "do nothing" kernel request
*
* @return N/A
*/
@@ -58,7 +58,7 @@
/**
*
- * _task_nop - "do nothing" kernel request
+ * @brief "do nothing" kernel request
*
* This routine is a request for the K_swapper to run a "do nothing" routine.
*
diff --git a/kernel/microkernel/k_offload.c b/kernel/microkernel/k_offload.c
index 0870a12..a020337 100644
--- a/kernel/microkernel/k_offload.c
+++ b/kernel/microkernel/k_offload.c
@@ -35,7 +35,7 @@
/**
*
- * _k_offload_to_fiber - process an "offload to fiber" request
+ * @brief Process an "offload to fiber" request
*
* This routine simply invokes the requested function from within the context
* of the K_swapper() fiber and saves the result.
@@ -50,7 +50,7 @@
/**
*
- * task_offload_to_fiber - issue a custom call from within K_swapper()
+ * @brief Issue a custom call from within K_swapper()
*
* @func: function to call from within K_swapper()
* @argp: argument to pass to custom function
diff --git a/kernel/microkernel/k_pipe.c b/kernel/microkernel/k_pipe.c
index 05cbef1..d9acc69 100644
--- a/kernel/microkernel/k_pipe.c
+++ b/kernel/microkernel/k_pipe.c
@@ -37,7 +37,7 @@
/**
*
- * _k_pipe_init - initialize kernel pipe subsystem
+ * @brief Initialize kernel pipe subsystem
*
* Performs any initialization of statically-defined pipes that wasn't done
* at build time. (Note: most pipe structure fields are set to zero by sysgen.)
@@ -59,7 +59,7 @@
/**
*
- * _task_pipe_get - pipe read request
+ * @brief Pipe read request
*
* This routine attempts to read data into a memory buffer area from the
* specified pipe.
@@ -114,7 +114,7 @@
/**
*
- * _task_pipe_put - pipe write request
+ * @brief Pipe write request
*
* This routine attempts to write data from a memory buffer area to the
* specified pipe.
@@ -169,7 +169,7 @@
/**
*
- * _task_pipe_put_async - asynchronous pipe write request
+ * @brief Asynchronous pipe write request
*
* This routine attempts to write data from a memory pool block to the
* specified pipe. (Note that partial transfers and timeouts are not
diff --git a/kernel/microkernel/k_pipe_get.c b/kernel/microkernel/k_pipe_get.c
index 35f465a..c26ee5b 100644
--- a/kernel/microkernel/k_pipe_get.c
+++ b/kernel/microkernel/k_pipe_get.c
@@ -38,7 +38,7 @@
/**
*
- * _k_pipe_get_request - process request command for a pipe get operation
+ * @brief Process request command for a pipe get operation
*
* @return N/A
*/
@@ -190,7 +190,7 @@
/**
*
- * _k_pipe_get_timeout - process timeout command for a pipe get operation
+ * @brief Process timeout command for a pipe get operation
*
* @return N/A
*/
@@ -210,7 +210,7 @@
/**
*
- * _k_pipe_get_reply - process reply command for a pipe get operation
+ * @brief Process reply command for a pipe get operation
*
* @return N/A
*/
@@ -261,7 +261,7 @@
/**
*
- * _k_pipe_get_ack - process acknowledgment command for a pipe get operation
+ * @brief Process acknowledgment command for a pipe get operation
*
* @return N/A
*/
diff --git a/kernel/microkernel/k_pipe_put.c b/kernel/microkernel/k_pipe_put.c
index b4df581..3cd6b15 100644
--- a/kernel/microkernel/k_pipe_put.c
+++ b/kernel/microkernel/k_pipe_put.c
@@ -39,7 +39,7 @@
/**
*
- * _k_pipe_put_request - process request command for a pipe put operation
+ * @brief Process request command for a pipe put operation
*
* @return N/A
*/
@@ -209,7 +209,7 @@
/**
*
- * _k_pipe_put_timeout - perform timeout command for a pipe put operation
+ * @brief Perform timeout command for a pipe put operation
*
* @return N/A
*/
@@ -229,7 +229,7 @@
/**
*
- * _k_pipe_put_reply - process reply command for a pipe put operation
+ * @brief Process reply command for a pipe put operation
*
* @return N/A
*/
@@ -282,7 +282,7 @@
/**
*
- * _k_pipe_put_ack - process acknowledgment command for a pipe put operation
+ * @brief Process acknowledgment command for a pipe put operation
*
* @return N/A
*/
diff --git a/kernel/microkernel/k_pipe_xfer.c b/kernel/microkernel/k_pipe_xfer.c
index ded7dbf..2393bce 100644
--- a/kernel/microkernel/k_pipe_xfer.c
+++ b/kernel/microkernel/k_pipe_xfer.c
@@ -207,7 +207,7 @@
/**
*
- * move_priority_compute - determines priority for data move operation
+ * @brief Determines priority for data move operation
*
* Uses priority level of most important participant.
*
@@ -410,7 +410,7 @@
/**
*
- * pipe_read - read from the channel
+ * @brief Read from the channel
*
* This routine reads from the channel. If <pPipe> is NULL, then it uses
* <pNewReader> as the reader. Otherwise it takes the reader from the channel
@@ -479,7 +479,7 @@
/**
*
- * pipe_write - write to the channel
+ * @brief Write to the channel
*
* This routine writes to the channel. If <pPipe> is NULL, then it uses
* <pNewWriter> as the writer. Otherwise it takes the writer from the channel
@@ -550,7 +550,7 @@
/**
*
- * pipe_xfer_status_update - update the channel transfer status
+ * @brief Update the channel transfer status
*
* @return N/A
*/
@@ -577,7 +577,7 @@
/**
*
- * pipe_read_write - read and/or write from/to the channel
+ * @brief Read and/or write from/to the channel
*
* @return N/A
*/
diff --git a/kernel/microkernel/k_semaphore.c b/kernel/microkernel/k_semaphore.c
index 6b7babb..7a5c0b9 100644
--- a/kernel/microkernel/k_semaphore.c
+++ b/kernel/microkernel/k_semaphore.c
@@ -38,7 +38,7 @@
/**
*
- * signal_semaphore - common code for signaling a semaphore
+ * @brief Common code for signaling a semaphore
*
* @return N/A
*/
@@ -96,7 +96,7 @@
/**
*
- * _k_sem_group_wait - finish handling incomplete waits on semaphores
+ * @brief Finish handling incomplete waits on semaphores
*
* @return N/A
*/
@@ -113,7 +113,7 @@
/**
*
- * _k_sem_group_wait_cancel - handle cancellation of a semaphore involved in a
+ * @brief Handle cancellation of a semaphore involved in a
* semaphore group wait request
*
* This routine only applies to semaphore group wait requests. It is invoked
@@ -179,7 +179,7 @@
/**
*
- * _k_sem_group_wait_accept - handle acceptance of the ready semaphore request
+ * @brief Handle acceptance of the ready semaphore request
*
* This routine only applies to semaphore group wait requests. It handles
* the request for the one semaphore in the group that "wins" the semaphore
@@ -218,7 +218,7 @@
/**
*
- * _k_sem_group_wait_timeout - handle semaphore group timeout request
+ * @brief Handle semaphore group timeout request
*
* @return N/A
*/
@@ -249,7 +249,7 @@
/**
*
- * _k_sem_group_ready - handle semaphore ready request
+ * @brief Handle semaphore ready request
*
* This routine only applies to semaphore group wait requests. It identifies
* the one semaphore in the group that "won" the semaphore group wait request
@@ -277,7 +277,7 @@
/**
*
- * _k_sem_wait_reply - reply to a semaphore wait request
+ * @brief Reply to a semaphore wait request
*
* @return N/A
*/
@@ -299,7 +299,7 @@
/**
*
- * _k_sem_group_wait_request - handle internal wait request on a semaphore involved in a
+ * @brief Handle internal wait request on a semaphore involved in a
* semaphore group wait request
*
* @return N/A
@@ -341,7 +341,7 @@
/**
*
- * _k_sem_group_wait_any - handle semaphore group wait request
+ * @brief Handle semaphore group wait request
*
* This routine splits the single semaphore group wait request into several
* internal wait requests--one for each semaphore in the group.
@@ -390,7 +390,7 @@
/**
*
- * _k_sem_wait_request - handle semaphore test and wait request
+ * @brief Handle semaphore test and wait request
*
* @return N/A
*/
@@ -427,7 +427,7 @@
/**
*
- * _task_sem_take - test a semaphore
+ * @brief Test a semaphore
*
* This routine tests a semaphore to see if it has been signaled. If the signal
* count is greater than zero, it is decremented.
@@ -451,7 +451,7 @@
/**
*
- * _task_sem_group_take - test multiple semaphores
+ * @brief Test multiple semaphores
*
* This routine tests a group of semaphores. A semaphore group is an array of
* semaphore names terminated by the predefined constant ENDLIST.
@@ -479,7 +479,7 @@
/**
*
- * _k_sem_signal - handle semaphore signal request
+ * @brief Handle semaphore signal request
*
* @return N/A
*/
@@ -493,7 +493,7 @@
/**
*
- * _k_sem_group_signal - handle signal semaphore group request
+ * @brief Handle signal semaphore group request
*
* @return N/A
*/
@@ -509,7 +509,7 @@
/**
*
- * task_sem_give - signal a semaphore
+ * @brief Signal a semaphore
*
* This routine signals the specified semaphore.
*
@@ -529,7 +529,7 @@
/**
*
- * task_sem_group_give - signal a group of semaphores
+ * @brief Signal a group of semaphores
*
* This routine signals a group of semaphores. A semaphore group is an array of
* semaphore names terminated by the predefined constant ENDLIST.
@@ -556,7 +556,7 @@
/**
*
- * fiber_sem_give - signal a semaphore from a fiber
+ * @brief Signal a semaphore from a fiber
*
* This routine (to only be called from a fiber) signals a semaphore. It
* requires a statically allocated command packet (from a command packet set)
@@ -570,7 +570,7 @@
/**
*
- * isr_sem_give - signal a semaphore from an ISR
+ * @brief Signal a semaphore from an ISR
*
* This routine (to only be called from an ISR) signals a semaphore. It
* requires a statically allocated command packet (from a command packet set)
@@ -602,7 +602,7 @@
/**
*
- * _k_sem_reset - handle semaphore reset request
+ * @brief Handle semaphore reset request
*
* @return N/A
*/
@@ -616,7 +616,7 @@
/**
*
- * _k_sem_group_reset - handle semaphore group reset request
+ * @brief Handle semaphore group reset request
*
* @return N/A
*/
@@ -632,7 +632,7 @@
/**
*
- * task_sem_reset - reset semaphore count to zero
+ * @brief Reset semaphore count to zero
*
* This routine resets the signal count of the specified semaphore to zero.
*
@@ -652,7 +652,7 @@
/**
*
- * task_sem_group_reset - reset a group of semaphores
+ * @brief Reset a group of semaphores
*
* This routine resets the signal count for a group of semaphores. A semaphore
* group is an array of semaphore names terminated by the predefined constant
@@ -674,7 +674,7 @@
/**
*
- * _k_sem_inquiry - handle semaphore inquiry request
+ * @brief Handle semaphore inquiry request
*
* @return N/A
*/
@@ -691,7 +691,7 @@
/**
*
- * task_sem_count_get - read the semaphore signal count
+ * @brief Read the semaphore signal count
*
* This routine reads the signal count of the specified semaphore.
*
diff --git a/kernel/microkernel/k_server.c b/kernel/microkernel/k_server.c
index da4b439..a895d66 100644
--- a/kernel/microkernel/k_server.c
+++ b/kernel/microkernel/k_server.c
@@ -52,7 +52,7 @@
/**
*
- * next_task_select - select task to be executed by microkernel
+ * @brief Select task to be executed by microkernel
*
* Locates that highest priority task queue that is non-empty and chooses the
* task at the head of that queue. It's guaranteed that there will always be
@@ -87,7 +87,7 @@
/**
*
- * K_swapper - the microkernel thread entry point
+ * @brief The microkernel thread entry point
*
* This function implements the microkernel fiber. It waits for command
* packets to arrive on its stack channel. It executes all commands on the
diff --git a/kernel/microkernel/k_task.c b/kernel/microkernel/k_task.c
index c68c717..a2cd180 100644
--- a/kernel/microkernel/k_task.c
+++ b/kernel/microkernel/k_task.c
@@ -45,7 +45,7 @@
/**
*
- * task_id_get - get task identifer
+ * @brief Get task identifer
*
* @return identifier for current task
*/
@@ -57,7 +57,7 @@
/**
*
- * _k_state_bit_reset - reset the specified task state bits
+ * @brief Reset the specified task state bits
*
* This routine resets the specified task state bits. When a task's state bits
* are zero, the task may be scheduled to run. The tasks's state bits are a
@@ -109,7 +109,7 @@
/**
*
- * _k_state_bit_set - set specified task state bits
+ * @brief Set specified task state bits
*
* This routine sets the specified task state bits. When a task's state bits
* are non-zero, the task will not be scheduled to run. The task's state bits
@@ -195,7 +195,7 @@
/**
*
- * start_task - initialize and start a task
+ * @brief Initialize and start a task
*
* @return N/A
*/
@@ -237,7 +237,7 @@
/**
*
- * abort_task - abort a task
+ * @brief Abort a task
*
* This routine aborts the specified task.
*
@@ -265,7 +265,7 @@
#ifndef CONFIG_ARCH_HAS_TASK_ABORT
/**
*
- * _TaskAbort - microkernel handler for fatal task errors
+ * @brief Microkernel handler for fatal task errors
*
* To be invoked when a task aborts implicitly, either by returning from its
* entry point or due to a software or hardware fault.
@@ -291,7 +291,7 @@
/**
*
- * task_abort_handler_set - install an abort handler
+ * @brief Install an abort handler
*
* This routine installs an abort handler for the calling task.
*
@@ -315,7 +315,7 @@
/**
*
- * _k_task_op - handle a task operation request
+ * @brief Handle a task operation request
*
* This routine handles any one of the following task operation requests:
* starting either a kernel or user task, aborting a task, suspending a task,
@@ -353,7 +353,7 @@
/**
*
- * _task_ioctl - task operations
+ * @brief Task operations
*
* @return N/A
*/
@@ -372,7 +372,7 @@
/**
*
- * _k_task_group_op - handle task group operation request
+ * @brief Handle task group operation request
*
* This routine handles any one of the following task group operations requests:
* starting either kernel or user tasks, aborting tasks, suspending tasks,
@@ -424,7 +424,7 @@
/**
*
- * _task_group_ioctl - task group operations
+ * @brief Task group operations
*
* @return N/A
*/
@@ -443,7 +443,7 @@
/**
*
- * task_group_mask_get - get task groups for task
+ * @brief Get task groups for task
*
* @return task groups associated with current task
*/
@@ -455,7 +455,7 @@
/**
*
- * task_group_join - add task to task group(s)
+ * @brief Add task to task group(s)
*
* @return N/A
*/
@@ -467,7 +467,7 @@
/**
*
- * task_group_leave - remove task from task group(s)
+ * @brief Remove task from task group(s)
*
* @return N/A
*/
@@ -479,7 +479,7 @@
/**
*
- * task_priority_get - get task priority
+ * @brief Get task priority
*
* @return priority of current task
*/
@@ -491,7 +491,7 @@
/**
*
- * _k_task_priority_set - handle task set priority request
+ * @brief Handle task set priority request
*
* @return N/A
*/
@@ -511,7 +511,7 @@
/**
*
- * task_priority_set - set the priority of a task
+ * @brief Set the priority of a task
*
* This routine changes the priority of the specified task.
*
@@ -538,7 +538,7 @@
/**
*
- * _k_task_yield - handle task yield request
+ * @brief Handle task yield request
*
* @return N/A
*/
@@ -559,7 +559,7 @@
/**
*
- * task_yield - yield the CPU to another task
+ * @brief Yield the CPU to another task
*
* This routine yields the processor to the next equal priority task that is
* runnable. Using task_yield(), it is possible to achieve the effect of round
@@ -579,7 +579,7 @@
/**
*
- * task_entry_set - set the entry point of a task
+ * @brief Set the entry point of a task
*
* This routine sets the entry point of a task to a given routine. It is only
* needed if the entry point is different from that specified in the project
diff --git a/kernel/microkernel/k_ticker.c b/kernel/microkernel/k_ticker.c
index af873aa..7d73b16 100644
--- a/kernel/microkernel/k_ticker.c
+++ b/kernel/microkernel/k_ticker.c
@@ -71,7 +71,7 @@
/**
*
- * task_cycle_get_32 - read the processor's high precision timer
+ * @brief Read the processor's high precision timer
*
* This routine reads the processor's high precision timer. It reads the
* counter register on the timer device. This counter register increments
@@ -89,7 +89,7 @@
/**
*
- * task_tick_get_32 - read the current system clock value
+ * @brief Read the current system clock value
*
* This routine returns the lower 32-bits of the current system clock value
* as measured in ticks.
@@ -104,7 +104,7 @@
/**
*
- * task_tick_get - read the current system clock value
+ * @brief Read the current system clock value
*
* This routine returns the current system clock value as measured in ticks.
*
@@ -126,7 +126,7 @@
/**
*
- * sys_clock_increment - increment system clock by "N" ticks
+ * @brief Increment system clock by "N" ticks
*
* Interrupts are locked while updating clock since some CPUs do not support
* native atomic operations on 64 bit values.
@@ -144,7 +144,7 @@
/**
*
- * _TlDebugUpdate - task level debugging tick handler
+ * @brief Task level debugging tick handler
*
* If task level debugging is configured this routine updates the low resolution
* debugging timer and determines if task level processing should be suspended.
@@ -168,7 +168,7 @@
/**
*
- * _TimeSliceUpdate - tick handler time slice logic
+ * @brief Tick handler time slice logic
*
* This routine checks to see if it is time for the current task
* to relinquish control, and yields CPU if so.
@@ -194,7 +194,7 @@
/**
*
- * _SysIdleElapsedTicksGet - get elapsed ticks
+ * @brief Get elapsed ticks
*
* If tickless idle support is configured this routine returns the number
* of ticks since going idle and then resets the global elapsed tick counter back
@@ -227,7 +227,7 @@
/**
*
- * _k_ticker - microkernel tick handler
+ * @brief Microkernel tick handler
*
* This routine informs other microkernel subsystems that a tick event has
* occurred.
@@ -258,7 +258,7 @@
/**
*
- * sys_scheduler_time_slice_set - set time slicing period and scope
+ * @brief Set time slicing period and scope
*
* This routine controls how task time slicing is performed by the task
* scheduler, by specifying the maximum time slice length (in ticks) and
@@ -295,7 +295,7 @@
/**
*
- * _k_time_elapse - handle elapsed ticks calculation request
+ * @brief Handle elapsed ticks calculation request
*
* This routine, called by K_swapper(), handles the request for calculating the
* time elapsed since the specified reference time.
@@ -313,7 +313,7 @@
/**
*
- * task_tick_delta - return ticks between calls
+ * @brief Return ticks between calls
*
* This function is meant to be used in contained fragments of code. The first
* call to it in a particular code fragment fills in a reference time variable
diff --git a/kernel/microkernel/k_timer.c b/kernel/microkernel/k_timer.c
index 78a7770..8f2729e 100644
--- a/kernel/microkernel/k_timer.c
+++ b/kernel/microkernel/k_timer.c
@@ -45,7 +45,7 @@
/**
*
- * _timer_id_to_ptr - convert timer pointer to timer object identifier
+ * @brief Convert timer pointer to timer object identifier
*
* This routine converts a timer pointer into a timer object identifier.
*
@@ -66,7 +66,7 @@
/**
*
- * _timer_id_to_ptr - convert timer object identifier to timer pointer
+ * @brief Convert timer object identifier to timer pointer
*
* This routine converts a timer object identifier into a timer pointer.
*
@@ -80,7 +80,7 @@
/**
*
- * _k_timer_enlist - insert a timer into the timer queue
+ * @brief Insert a timer into the timer queue
*
* @return N/A
*/
@@ -112,7 +112,7 @@
/**
*
- * _k_timer_delist - remove a timer from the timer queue
+ * @brief Remove a timer from the timer queue
*
* @return N/A
*/
@@ -136,7 +136,7 @@
/**
*
- * _k_timeout_alloc - allocate timer used for command packet timeout
+ * @brief Allocate timer used for command packet timeout
*
* Allocates timer for command packet and inserts it into the timer queue.
*
@@ -157,7 +157,7 @@
/**
*
- * _k_timeout_cancel - cancel timer used for command packet timeout
+ * @brief Cancel timer used for command packet timeout
*
* Cancels timer (if not already expired), then reschedules the command packet
* for further processing.
@@ -180,7 +180,7 @@
/**
*
- * _k_timeout_free - free timer used for command packet timeout
+ * @brief Free timer used for command packet timeout
*
* Cancels timer (if not already expired), then frees it.
*
@@ -196,7 +196,7 @@
/**
*
- * _k_timer_list_update - handle expired timers
+ * @brief Handle expired timers
*
* Process the sorted list of timers associated with waiting tasks and
* activate each task whose timer has now expired.
@@ -246,7 +246,7 @@
/**
*
- * _k_timer_alloc - handle timer allocation request
+ * @brief Handle timer allocation request
*
* This routine, called by K_swapper(), handles the request for allocating a
* timer.
@@ -271,7 +271,7 @@
/**
*
- * task_timer_alloc - allocate a timer and return its object identifier
+ * @brief Allocate a timer and return its object identifier
*
* @return timer identifier
*/
@@ -288,7 +288,7 @@
/**
*
- * _k_timer_dealloc - handle timer deallocation request
+ * @brief Handle timer deallocation request
*
* This routine, called by K_swapper(), handles the request for deallocating a
* timer.
@@ -310,7 +310,7 @@
/**
*
- * task_timer_free - deallocate a timer
+ * @brief Deallocate a timer
*
* This routine frees the resources associated with the timer. If a timer was
* started, it has to be stopped using task_timer_stop() before it can be freed.
@@ -331,7 +331,7 @@
/**
*
- * _k_timer_start - handle start timer request
+ * @brief Handle start timer request
*
* This routine, called by K_swapper(), handles the start timer request from
* both task_timer_start() and task_timer_restart().
@@ -380,7 +380,7 @@
/**
*
- * task_timer_start - start or restart the specified low resolution timer
+ * @brief Start or restart the specified low resolution timer
*
* This routine starts or restarts the specified low resolution timer.
*
@@ -418,7 +418,7 @@
/**
*
- * task_timer_restart - restart a timer
+ * @brief Restart a timer
*
* This routine restarts the timer specified by <timer>.
*
@@ -443,7 +443,7 @@
/**
*
- * _k_timer_stop - handle stop timer request
+ * @brief Handle stop timer request
*
* This routine, called by K_swapper(), handles the request for stopping a
* timer.
@@ -461,7 +461,7 @@
/**
*
- * task_timer_stop - stop a timer
+ * @brief Stop a timer
*
* This routine stops the specified timer. If the timer period has already
* elapsed, the call has no effect.
@@ -482,7 +482,7 @@
/**
*
- * _k_task_wakeup - handle internally issued task wakeup request
+ * @brief Handle internally issued task wakeup request
*
* This routine, called by K_swapper(), handles the request for waking a task
* at the end of its sleep period.
@@ -504,7 +504,7 @@
/**
*
- * _k_task_sleep - handle task sleep request
+ * @brief Handle task sleep request
*
* This routine, called by K_swapper(), handles the request for putting a task
* to sleep.
@@ -535,7 +535,7 @@
/**
*
- * task_sleep - sleep for a number of ticks
+ * @brief Sleep for a number of ticks
*
* This routine suspends the calling task for the specified number of timer
* ticks. When the task is awakened, it is rescheduled according to its
diff --git a/kernel/nanokernel/compiler_stack_protect.c b/kernel/nanokernel/compiler_stack_protect.c
index 4792855..97e6bbc 100644
--- a/kernel/nanokernel/compiler_stack_protect.c
+++ b/kernel/nanokernel/compiler_stack_protect.c
@@ -50,7 +50,7 @@
/**
*
- * _StackCheckHandler - stack canary error handler
+ * @brief Stack canary error handler
*
* This function is invoked when a stack canary error is detected.
*
@@ -80,7 +80,7 @@
/**
*
- * __stack_chk_fail - Referenced by GCC compiler generated code
+ * @brief Referenced by GCC compiler generated code
*
* This routine is invoked when a stack canary error is detected, indicating
* a buffer overflow or stack corruption problem.
diff --git a/kernel/nanokernel/ctors.c b/kernel/nanokernel/ctors.c
index 8a59dab..d988d47 100644
--- a/kernel/nanokernel/ctors.c
+++ b/kernel/nanokernel/ctors.c
@@ -63,7 +63,7 @@
/**
*
- * _Ctors - invoke all C++ style global object constructors
+ * @brief Invoke all C++ style global object constructors
*
* This function is invoked by _Cstart(), which is implemented in the BSP. It
* invokes all routines that have been tagged using NANO_INIT_xxx, in order
diff --git a/kernel/nanokernel/idle.c b/kernel/nanokernel/idle.c
index c5fd199..6f6289a 100644
--- a/kernel/nanokernel/idle.c
+++ b/kernel/nanokernel/idle.c
@@ -45,7 +45,7 @@
/**
*
- * nano_cpu_set_idle - indicate that nanokernel is idling in tickless mode
+ * @brief Indicate that nanokernel is idling in tickless mode
*
* Sets the nanokernel data structure idle field to a non-zero value.
*
diff --git a/kernel/nanokernel/int_latency_bench.c b/kernel/nanokernel/int_latency_bench.c
index 103ea5c..bfec9f3 100644
--- a/kernel/nanokernel/int_latency_bench.c
+++ b/kernel/nanokernel/int_latency_bench.c
@@ -68,7 +68,7 @@
/**
*
- * intLatencyStart - start tracking time spent with interrupts locked
+ * @brief Start tracking time spent with interrupts locked
*
* calls to lock interrupt can nest, so this routine can be called numerous
* times before interrupt are unlocked
@@ -89,7 +89,7 @@
/**
*
- * intLatencyStop - stop accumulating time spent for when interrupts are locked
+ * @brief Stop accumulating time spent for when interrupts are locked
*
* This is only call once when the interrupt are being reenabled
*
@@ -142,7 +142,7 @@
/**
*
- * int_latency_init - initialize interrupt latency benchmark
+ * @brief Initialize interrupt latency benchmark
*
* @return N/A
*
@@ -193,7 +193,7 @@
/**
*
- * int_latency_show - dumps interrupt latency values
+ * @brief Dumps interrupt latency values
*
* The interrupt latency value measures
*
diff --git a/kernel/nanokernel/nano_context.c b/kernel/nanokernel/nano_context.c
index 18ab7b6..37b8693 100644
--- a/kernel/nanokernel/nano_context.c
+++ b/kernel/nanokernel/nano_context.c
@@ -44,7 +44,7 @@
/**
*
- * context_self_get - return the currently executing context
+ * @brief Return the currently executing context
*
* This routine returns a pointer to the context control block of the currently
* executing context. It is cast to a nano_context_id_t for use publically.
@@ -59,7 +59,7 @@
/**
*
- * context_type_get - return the type of the currently executing context
+ * @brief Return the type of the currently executing context
*
* This routine returns the type of context currently executing.
*
@@ -79,7 +79,7 @@
/**
*
- * _context_essential_set - mark context as essential to system
+ * @brief Mark context as essential to system
*
* This function tags the running fiber or task as essential to system
* option; exceptions raised by this context will be treated as a fatal
@@ -95,7 +95,7 @@
/**
*
- * _context_essential_clear - mark context as not essential to system
+ * @brief Mark context as not essential to system
*
* This function tags the running fiber or task as not essential to system
* option; exceptions raised by this context may be recoverable.
@@ -111,7 +111,7 @@
/**
*
- * _context_essential_check - is the specified context essential?
+ * @brief Is the specified context essential?
*
* This routine indicates if the specified context is an essential system
* context. A NULL context pointer indicates that the current context is
@@ -130,7 +130,7 @@
/**
*
- * context_custom_data_set - set context's custom data
+ * @brief Set context's custom data
*
* This routine sets the custom data value for the current task or fiber.
* Custom data is not used by the kernel itself, and is freely available
@@ -147,7 +147,7 @@
/**
*
- * context_custom_data_get - get context's custom data
+ * @brief Get context's custom data
*
* This function returns the custom data value for the current task or fiber.
*
@@ -164,7 +164,7 @@
#if defined(CONFIG_CONTEXT_MONITOR)
/**
*
- * _context_exit - context exit routine
+ * @brief Context exit routine
*
* This function is invoked when the specified context is aborted, either
* normally or abnormally. It is called for the termination of any context,
@@ -202,7 +202,7 @@
/**
*
- * _context_entry - common context entry point function for kernel contexts
+ * @brief Common context entry point function for kernel contexts
*
* This function serves as the entry point for _all_ kernel contexts, i.e. both
* task and fiber contexts are instantiated such that initial execution starts
diff --git a/kernel/nanokernel/nano_fiber.c b/kernel/nanokernel/nano_fiber.c
index 906fd97..784aeeb 100644
--- a/kernel/nanokernel/nano_fiber.c
+++ b/kernel/nanokernel/nano_fiber.c
@@ -43,7 +43,7 @@
/**
*
- * _nano_fiber_schedule - add a fiber to the list of runnable fibers
+ * @brief Add a fiber to the list of runnable fibers
*
* The list of runnable fibers is maintained via a single linked list
* in priority order. Numerically lower priorities represent higher priority
@@ -83,7 +83,7 @@
/**
*
- * _fiber_start - initialize and start a fiber context
+ * @brief Initialize and start a fiber context
*
* This routine initilizes and starts a fiber context; it can be called from
* either a fiber or a task context. When this routine is called from a
@@ -147,7 +147,7 @@
/**
*
- * fiber_yield - yield the current context
+ * @brief Yield the current context
*
* Invocation of this routine results in the current context yielding to
* another context of the same or higher priority. If there doesn't exist
@@ -179,7 +179,7 @@
/**
*
- * _nano_fiber_swap - pass control from the currently executing fiber
+ * @brief Pass control from the currently executing fiber
*
* This routine is used when a fiber voluntarily gives up control of the CPU.
*
@@ -214,7 +214,7 @@
#ifndef CONFIG_ARCH_HAS_NANO_FIBER_ABORT
/**
*
- * fiber_abort - abort the currently executing fiber
+ * @brief Abort the currently executing fiber
*
* This routine is used to abort the currrently executing fiber. This can occur
* because:
diff --git a/kernel/nanokernel/nano_fifo.c b/kernel/nanokernel/nano_fifo.c
index 8dcdc06..8625522 100644
--- a/kernel/nanokernel/nano_fifo.c
+++ b/kernel/nanokernel/nano_fifo.c
@@ -53,7 +53,7 @@
/**
*
- * nano_fifo_init - initialize a nanokernel multiple-waiter fifo (fifo) object
+ * @brief Initialize a nanokernel multiple-waiter fifo (fifo) object
*
* This function initializes a nanokernel multiple-waiter fifo (fifo) object
* structure.
@@ -96,7 +96,7 @@
/**
*
- * enqueue_data - internal routine to append data to a fifo
+ * @brief Internal routine to append data to a fifo
*
* @return N/A
*/
@@ -110,7 +110,7 @@
/**
*
- * _fifo_put_non_preemptible - append an element to a fifo (no context switch)
+ * @brief Append an element to a fifo (no context switch)
*
* This routine adds an element to the end of a fifo object; it may be called
* from either either a fiber or an ISR context. A fiber pending on the fifo
@@ -151,7 +151,7 @@
/**
*
- * nano_task_fifo_put - add an element to the end of a fifo
+ * @brief Add an element to the end of a fifo
*
* This routine adds an element to the end of a fifo object; it can be called
* from only a task context. A fiber pending on the fifo object will be made
@@ -188,7 +188,7 @@
/**
*
- * nano_fifo_put - add an element to the end of a fifo
+ * @brief Add an element to the end of a fifo
*
* This is a convenience wrapper for the context-specific APIs. This is
* helpful whenever the exact scheduling context is not known, but should
@@ -210,7 +210,7 @@
/**
*
- * dequeue_data - internal routine to remove data from a fifo
+ * @brief Internal routine to remove data from a fifo
*
* @return the data item removed
*/
@@ -235,7 +235,7 @@
/**
*
- * _fifo_get - get an element from the head a fifo
+ * @brief Get an element from the head a fifo
*
* Remove the head element from the specified nanokernel multiple-waiter fifo
* linked list fifo; it may be called from a fiber, task, or ISR context.
@@ -273,7 +273,7 @@
/**
*
- * nano_fiber_fifo_get_wait - get the head element of a fifo, wait if emtpy
+ * @brief Get the head element of a fifo, wait if emtpy
*
* Remove the head element from the specified system-level multiple-waiter
* fifo; it can only be called from a fiber context.
@@ -314,7 +314,7 @@
/**
*
- * nano_task_fifo_get_wait - get the head element of a fifo, poll if empty
+ * @brief Get the head element of a fifo, poll if empty
*
* Remove the head element from the specified system-level multiple-waiter
* fifo; it can only be called from a task context.
@@ -362,7 +362,7 @@
/**
*
- * nano_fifo_get_wait - get the head element of a fifo, poll/pend if empty
+ * @brief Get the head element of a fifo, poll/pend if empty
*
* This is a convenience wrapper for the context-specific APIs. This is
* helpful whenever the exact scheduling context is not known, but should
diff --git a/kernel/nanokernel/nano_init.c b/kernel/nanokernel/nano_init.c
index 88442ec..8095e56 100644
--- a/kernel/nanokernel/nano_init.c
+++ b/kernel/nanokernel/nano_init.c
@@ -150,7 +150,7 @@
/**
*
- * nano_init - initializes nanokernel data structures
+ * @brief Initializes nanokernel data structures
*
* This routine initializes various nanokernel data structures, including
* the background (or idle) task and any architecture-specific initialization.
@@ -221,7 +221,7 @@
#ifdef CONFIG_STACK_CANARIES
/**
*
- * STACK_CANARY_INIT - initialize the kernel's stack canary
+ * @brief Initialize the kernel's stack canary
*
* This macro initializes the kernel's stack canary global variable,
* __stack_chk_guard, with a random value.
@@ -256,7 +256,7 @@
/**
*
- * _Cstart - initialize nanokernel
+ * @brief Initialize nanokernel
*
* This routine is invoked by the BSP when the system is ready to run C code.
* The processor must be running in 32-bit mode, and the BSS must have been
diff --git a/kernel/nanokernel/nano_lifo.c b/kernel/nanokernel/nano_lifo.c
index 0dc4030..f5c1c38 100644
--- a/kernel/nanokernel/nano_lifo.c
+++ b/kernel/nanokernel/nano_lifo.c
@@ -52,7 +52,7 @@
/**
*
- * nano_lifo_init - initialize a nanokernel linked list lifo object
+ * @brief Initialize a nanokernel linked list lifo object
*
* This function initializes a nanokernel system-level linked list lifo
* object structure.
@@ -80,7 +80,7 @@
/**
*
- * _lifo_put_non_preemptible - prepend an element to a lifo (no context switch)
+ * @brief Prepend an element to a lifo (no context switch)
*
* This routine adds an element to the head of a lifo object; it may be
* called from either a fiber or an ISR context. A fiber pending on the lifo
@@ -118,7 +118,7 @@
/**
*
- * nano_task_lifo_put - add an element to the head of a linked list lifo
+ * @brief Add an element to the head of a linked list lifo
*
* This routine adds an element to the head of a lifo object; it can be
* called only from a task context. A fiber pending on the lifo
@@ -158,7 +158,7 @@
/**
*
- * _lifo_get - remove the first element from a linked list lifo
+ * @brief Remove the first element from a linked list lifo
*
* Remove the first element from the specified nanokernel linked list lifo;
* it may be called from a fiber, task, or ISR context.
@@ -198,7 +198,7 @@
/**
*
- * nano_fiber_lifo_get_wait - get the first element from a LIFO, wait if empty
+ * @brief Get the first element from a LIFO, wait if empty
*
* Remove the first element from the specified system-level linked list lifo;
* it can only be called from a fiber context.
@@ -240,7 +240,7 @@
/**
*
- * nano_task_lifo_get_wait - get the first element from a lifo, poll if empty
+ * @brief Get the first element from a lifo, poll if empty
*
* Remove the first element from the specified nanokernel linked list lifo; it
* can only be called from a task context.
@@ -289,7 +289,7 @@
/**
*
- * _nano_fiber_lifo_get_panic - get first element from lifo and panic if NULL
+ * @brief Get first element from lifo and panic if NULL
*
* Get the first element from the specified lifo but generate a fatal error
* if the element is NULL.
diff --git a/kernel/nanokernel/nano_sema.c b/kernel/nanokernel/nano_sema.c
index 3811c1f..13cf7d4 100644
--- a/kernel/nanokernel/nano_sema.c
+++ b/kernel/nanokernel/nano_sema.c
@@ -58,7 +58,7 @@
/**
*
- * nano_sem_init - initialize a nanokernel semaphore object
+ * @brief Initialize a nanokernel semaphore object
*
* This function initializes a nanokernel semaphore object structure. After
* initialization, the semaphore count will be 0.
@@ -92,7 +92,7 @@
/**
*
- * _sem_give_non_preemptible - give a nanokernel semaphore (no context switch)
+ * @brief Give a nanokernel semaphore (no context switch)
*
* This routine performs a "give" operation on a nanokernel sempahore object;
* it may be call from either a fiber or an ISR context. A fiber pending on
@@ -129,7 +129,7 @@
/**
*
- * nano_task_sem_give - give a nanokernel semaphore
+ * @brief Give a nanokernel semaphore
*
* This routine performs a "give" operation on a nanokernel sempahore object;
* it can only be called from a task context. A fiber pending on the
@@ -162,7 +162,7 @@
/**
*
- * nano_sem_give - give a nanokernel semaphore
+ * @brief Give a nanokernel semaphore
*
* This is a convenience wrapper for the context-specific APIs. This is
* helpful whenever the exact scheduling context is not known, but should
@@ -184,7 +184,7 @@
/**
*
- * _sem_take - take a nanokernel semaphore, fail if unavailable
+ * @brief Take a nanokernel semaphore, fail if unavailable
*
* Attempt to take a nanokernel sempahore; it may be called from a fiber, task,
* or ISR context.
@@ -212,7 +212,7 @@
/**
*
- * nano_fiber_sem_take_wait - test a nanokernel semaphore, wait if unavailable
+ * @brief Test a nanokernel semaphore, wait if unavailable
*
* Take a nanokernel sempahore; it can only be called from a fiber context.
*
@@ -246,7 +246,7 @@
/**
*
- * nano_task_sem_take_wait - take a nanokernel semaphore, poll if unavailable
+ * @brief Take a nanokernel semaphore, poll if unavailable
*
* Take a nanokernel sempahore; it can only be called from a task context.
*
@@ -287,7 +287,7 @@
/**
*
- * nano_sem_take_wait - take a nanokernel semaphore, poll/pend if not available
+ * @brief Take a nanokernel semaphore, poll/pend if not available
*
* This is a convenience wrapper for the context-specific APIs. This is
* helpful whenever the exact scheduling context is not known, but should
diff --git a/kernel/nanokernel/nano_stack.c b/kernel/nanokernel/nano_stack.c
index 48a97d5..8cde219 100644
--- a/kernel/nanokernel/nano_stack.c
+++ b/kernel/nanokernel/nano_stack.c
@@ -52,7 +52,7 @@
/**
*
- * nano_stack_init - initialize a nanokernel stack object
+ * @brief Initialize a nanokernel stack object
*
* This function initializes a nanokernel stack object structure.
*
@@ -80,7 +80,7 @@
/**
*
- * _stack_push_non_preemptible - push data onto a stack (no context switch)
+ * @brief Push data onto a stack (no context switch)
*
* This routine pushes a data item onto a stack object; it may be called from
* either a fiber or ISR context. A fiber pending on the stack object will be
@@ -120,7 +120,7 @@
/**
*
- * nano_task_stack_push - push data onto a nanokernel stack
+ * @brief Push data onto a nanokernel stack
*
* This routine pushes a data item onto a stack object; it may be called only
* from a task context. A fiber pending on the stack object will be
@@ -160,7 +160,7 @@
/**
*
- * _stack_pop - pop data from a nanokernel stack
+ * @brief Pop data from a nanokernel stack
*
* Pop the first data word from a nanokernel stack object; it may be called
* from a fiber, task, or ISR context.
@@ -201,7 +201,7 @@
/**
*
- * nano_fiber_stack_pop_wait - pop data from a nanokernel stack, wait if empty
+ * @brief Pop data from a nanokernel stack, wait if empty
*
* Pop the first data word from a nanokernel stack object; it can only be
* called from a fiber context
@@ -240,7 +240,7 @@
/**
*
- * nano_task_stack_pop_wait - pop data from a nanokernel stack, poll if empty
+ * @brief Pop data from a nanokernel stack, poll if empty
*
* Pop the first data word from a nanokernel stack; it can only be called
* from a task context.
diff --git a/kernel/nanokernel/nano_sys_clock.c b/kernel/nanokernel/nano_sys_clock.c
index 5821167..e4703bc 100644
--- a/kernel/nanokernel/nano_sys_clock.c
+++ b/kernel/nanokernel/nano_sys_clock.c
@@ -55,7 +55,7 @@
/**
*
- * nano_time_init - constructor that initializes nanokernel time tracking system
+ * @brief Constructor that initializes nanokernel time tracking system
*
* @return N/A
*
@@ -74,7 +74,7 @@
/**
*
- * nano_tick_get_32 - return the lower part of the current system tick count
+ * @brief Return the lower part of the current system tick count
*
* @return the current system tick count
*
@@ -87,7 +87,7 @@
/**
*
- * nano_tick_get - return the current system tick count
+ * @brief Return the current system tick count
*
* @return the current system tick count
*
@@ -110,7 +110,7 @@
/**
*
- * nano_cycle_get_32 - return a high resolution timestamp
+ * @brief Return a high resolution timestamp
*
* @return the current timer hardware count
*
@@ -123,7 +123,7 @@
/**
*
- * nano_tick_delta - return number of ticks since a reference time
+ * @brief Return number of ticks since a reference time
*
* This function is meant to be used in contained fragments of code. The first
* call to it in a particular code fragment fills in a reference time variable
@@ -172,7 +172,7 @@
/**
*
- * nano_tick_delta - return number of ticks since a reference time
+ * @brief Return number of ticks since a reference time
*
* @return tick count since reference time; undefined for first invocation
*/
@@ -184,7 +184,7 @@
/**
*
- * nano_tick_delta_32 - return 32-bit number of ticks since a reference time
+ * @brief Return 32-bit number of ticks since a reference time
*
* @return 32-bit tick count since reference time; undefined for first invocation
*/
@@ -236,7 +236,7 @@
#if defined(CONFIG_NANO_TIMEOUTS) || defined(CONFIG_NANO_TIMERS)
/**
*
- * _nano_sys_clock_tick_announce - announce a tick to the nanokernel
+ * @brief Announce a tick to the nanokernel
*
* This function is only to be called by the system clock timer driver when a
* tick is to be announced to the nanokernel. It takes care of dequeuing the
diff --git a/kernel/nanokernel/nano_timer.c b/kernel/nanokernel/nano_timer.c
index b71d12e..1f9be29 100644
--- a/kernel/nanokernel/nano_timer.c
+++ b/kernel/nanokernel/nano_timer.c
@@ -36,7 +36,7 @@
/**
*
- * nano_timer_init - initialize a nanokernel timer object
+ * @brief Initialize a nanokernel timer object
*
* This function initializes a nanokernel timer object structure.
*
@@ -58,7 +58,7 @@
/**
*
- * nano_fiber_timer_start - start a nanokernel timer from a fiber
+ * @brief Start a nanokernel timer from a fiber
*
* This function starts a previously initialized nanokernel timer object.
* The timer will expire in <ticks> system clock ticks.
@@ -71,7 +71,7 @@
/**
*
- * nano_task_timer_start - start a nanokernel timer from a task
+ * @brief Start a nanokernel timer from a task
*
* This function starts a previously initialized nanokernel timer object.
* The timer will expire in <ticks> system clock ticks.
@@ -84,7 +84,7 @@
/**
*
- * _timer_start - start a nanokernel timer (generic implementation)
+ * @brief Start a nanokernel timer (generic implementation)
*
* This function starts a previously initialized nanokernel timer object.
* The timer will expire in <ticks> system clock ticks.
@@ -129,7 +129,7 @@
/**
*
- * _timer_stop - stop a nanokernel timer (generic implementation)
+ * @brief Stop a nanokernel timer (generic implementation)
*
* This function stops a previously started nanokernel timer object.
*
@@ -178,7 +178,7 @@
/**
*
- * nano_fiber_timer_stop - stop a nanokernel timer from a fiber
+ * @brief Stop a nanokernel timer from a fiber
*
* This function stops a previously started nanokernel timer object.
*
@@ -200,7 +200,7 @@
/**
*
- * nano_task_timer_stop - stop a nanokernel timer from a task
+ * @brief Stop a nanokernel timer from a task
*
* This function stops a previously started nanokernel timer object.
*
@@ -222,7 +222,7 @@
/**
*
- * nano_fiber_timer_test - make the current fiber check for a timer expiry
+ * @brief Make the current fiber check for a timer expiry
*
* This function will check if a timer has expired. The timer must
* have been initialized by nano_timer_init() and started via either
@@ -240,7 +240,7 @@
/**
*
- * nano_fiber_timer_wait - make the current fiber wait for a timer to expire
+ * @brief Make the current fiber wait for a timer to expire
*
* This function will pend on a timer if it hasn't expired yet. The timer must
* have been initialized by nano_timer_init() and started via either
@@ -259,7 +259,7 @@
/**
*
- * nano_task_timer_test - make the current task check for a timer expiry
+ * @brief Make the current task check for a timer expiry
*
* This function will check if a timer has expired. The timer must
* have been initialized by nano_timer_init() and started via either
@@ -277,7 +277,7 @@
/**
*
- * nano_task_timer_wait - make the current task wait for a timer to expire
+ * @brief Make the current task wait for a timer to expire
*
* This function will pend on a timer if it hasn't expired yet. The timer must
* have been initialized by nano_timer_init() and started via either
diff --git a/kernel/nanokernel/version.c b/kernel/nanokernel/version.c
index 7215ff1..ebd2d1f 100644
--- a/kernel/nanokernel/version.c
+++ b/kernel/nanokernel/version.c
@@ -37,7 +37,7 @@
/**
*
- * sys_kernel_version_get - return the kernel version of the present build
+ * @brief Return the kernel version of the present build
*
* The kernel version is a four-byte value, whose format is decribed in the
* file "kernel_version.h".
diff --git a/lib/libc/minimal/source/stdout/prf.c b/lib/libc/minimal/source/stdout/prf.c
index ce72b00..f16b8af 100644
--- a/lib/libc/minimal/source/stdout/prf.c
+++ b/lib/libc/minimal/source/stdout/prf.c
@@ -502,7 +502,7 @@
/**
*
- * _isdigit - is the input value an ASCII digit character?
+ * @brief Is the input value an ASCII digit character?
*
* This function provides a traditional implementation of the isdigit()
* primitive that is footprint conversative, i.e. it does not utilize a
diff --git a/lib/libc/minimal/source/string/string.c b/lib/libc/minimal/source/string/string.c
index b2d81b9..cdd7137 100644
--- a/lib/libc/minimal/source/string/string.c
+++ b/lib/libc/minimal/source/string/string.c
@@ -34,7 +34,7 @@
/**
*
- * strcpy - copy a string
+ * @brief Copy a string
*
* @return pointer to destination buffer <d>
*/
@@ -56,7 +56,7 @@
/**
*
- * strncpy - copy part of a string
+ * @brief Copy part of a string
*
* @return pointer to destination buffer <d>
*/
@@ -83,7 +83,7 @@
/**
*
- * strchr - string scanning operation
+ * @brief String scanning operation
*
* @return pointer to 1st instance of found byte, or NULL if not found
*/
@@ -100,7 +100,7 @@
/**
*
- * strlen - get string length
+ * @brief Get string length
*
* @return number of bytes in string <s>
*/
@@ -119,7 +119,7 @@
/**
*
- * strcmp - compare two strings
+ * @brief Compare two strings
*
* @return negative # if <s1> < <s2>, 0 if <s1> == <s2>, else positive #
*/
@@ -136,7 +136,7 @@
/**
*
- * strncmp - compare part of two strings
+ * @brief Compare part of two strings
*
* @return negative # if <s1> < <s2>, 0 if <s1> == <s2>, else positive #
*/
@@ -154,7 +154,7 @@
/**
*
- * memcmp - compare two memory areas
+ * @brief Compare two memory areas
*
* @return negative # if <m1> < <m2>, 0 if <m1> == <m2>, else positive #
*/
@@ -177,7 +177,7 @@
/**
*
- * memmove - copy bytes in memory with overlapping areas
+ * @brief Copy bytes in memory with overlapping areas
*
* @return pointer to destination buffer <d>
*/
@@ -212,7 +212,7 @@
/**
*
- * memcpy - copy bytes in memory
+ * @brief Copy bytes in memory
*
* @return pointer to start of destination buffer
*/
@@ -262,7 +262,7 @@
/**
*
- * memset - set bytes in memory
+ * @brief Set bytes in memory
*
* @return pointer to start of buffer
*/
diff --git a/misc/printk.c b/misc/printk.c
index b0cd61b..223e63d 100644
--- a/misc/printk.c
+++ b/misc/printk.c
@@ -48,7 +48,7 @@
/**
*
- * _nop_char_out - default character output routine that does nothing
+ * @brief Default character output routine that does nothing
*
* @return 0
*/
@@ -67,7 +67,7 @@
/**
*
- * __printk_hook_install - install the character output routine for printk
+ * @brief Install the character output routine for printk
*
* To be called by the BSP's console driver at init time. Installs a routine
* that outputs one ASCII character at a time.
@@ -83,7 +83,7 @@
/**
*
- * _vprintk - printk internals
+ * @brief Printk internals
*
* See printk() for description.
*
@@ -156,7 +156,7 @@
/**
*
- * printk - output a string
+ * @brief Output a string
*
* Output a string on output installed by BSP at init time. Some printf-like
* formatting is available.
@@ -184,7 +184,7 @@
/**
*
- * _printk_hex_ulong - output an unsigned long in hex format
+ * @brief Output an unsigned long in hex format
*
* Output an unsigned long on output installed by BSP at init time. Should be
* able to handle an unsigned long of any size, 32 or 64 bit.
@@ -207,7 +207,7 @@
/**
*
- * _printk_dec_ulong - output an unsigned long (32-bit) in decimal format
+ * @brief Output an unsigned long (32-bit) in decimal format
*
* Output an unsigned long on output installed by BSP at init time. Only works
* with 32-bit values.
@@ -238,7 +238,7 @@
/**
*
- * printk - output a string
+ * @brief Output a string
*
* Debugging output is dropped if it is not to be sent to the console.
*
diff --git a/samples/include/irq_test_common.h b/samples/include/irq_test_common.h
index 1ef4f2e..14f2924 100644
--- a/samples/include/irq_test_common.h
+++ b/samples/include/irq_test_common.h
@@ -107,7 +107,7 @@
/**
*
- * initIRQ - init interrupts
+ * @brief Init interrupts
*
*/
diff --git a/samples/microkernel/apps/philosophers/src/phil_fiber.c b/samples/microkernel/apps/philosophers/src/phil_fiber.c
index 06cb2f1..1e4aae41 100644
--- a/samples/microkernel/apps/philosophers/src/phil_fiber.c
+++ b/samples/microkernel/apps/philosophers/src/phil_fiber.c
@@ -63,7 +63,7 @@
/**
*
- * myPrint - print a philosophers state
+ * @brief Print a philosophers state
*
* @param id Philosopher ID.
* @param str EATING or THINKING.
@@ -78,7 +78,7 @@
/**
*
- * myDelay - wait for a number of ticks to elapse
+ * @brief Wait for a number of ticks to elapse
*
* @param ticks Number of ticks to delay.
*
@@ -100,7 +100,7 @@
/**
*
- * philEntry - entry point to a philosopher's thread
+ * @brief Entry point to a philosopher's thread
*
* This routine runs as a task in the microkernel environment
* and as a fiber in the nanokernel environment.
diff --git a/samples/microkernel/apps/philosophers/src/phil_task.c b/samples/microkernel/apps/philosophers/src/phil_task.c
index 65329c4..3830093 100644
--- a/samples/microkernel/apps/philosophers/src/phil_task.c
+++ b/samples/microkernel/apps/philosophers/src/phil_task.c
@@ -63,7 +63,7 @@
#ifdef CONFIG_NANOKERNEL
/**
*
- * main - nanokernel entry point
+ * @brief Nanokernel entry point
*
* @return does not return
*/
@@ -95,7 +95,7 @@
#else
/**
*
- * philDemo - routine to start dining philosopher demo
+ * @brief Routine to start dining philosopher demo
*
* @return does not return
*/
diff --git a/samples/microkernel/benchmark/app_kernel/src/event_b.c b/samples/microkernel/benchmark/app_kernel/src/event_b.c
index 2092098..876d44b 100644
--- a/samples/microkernel/benchmark/app_kernel/src/event_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/event_b.c
@@ -58,7 +58,7 @@
/**
*
- * event_test - event signal speed test
+ * @brief Event signal speed test
*
* @return N/A
*
@@ -179,7 +179,7 @@
/**
*
- * example_handler - event handler for the tests
+ * @brief Event handler for the tests
*
* The event handler for the test. Sets up nEventValue global variable.
* This variable is used in the main test.
diff --git a/samples/microkernel/benchmark/app_kernel/src/fifo_b.c b/samples/microkernel/benchmark/app_kernel/src/fifo_b.c
index 209dcb5..88cd8f5 100644
--- a/samples/microkernel/benchmark/app_kernel/src/fifo_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/fifo_b.c
@@ -36,7 +36,7 @@
/**
*
- * queue_test - queue transfer speed test
+ * @brief Queue transfer speed test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/fifo_r.c b/samples/microkernel/benchmark/app_kernel/src/fifo_r.c
index eb3144f..571556e 100644
--- a/samples/microkernel/benchmark/app_kernel/src/fifo_r.c
+++ b/samples/microkernel/benchmark/app_kernel/src/fifo_r.c
@@ -38,7 +38,7 @@
/* queue transfer speed test */
/**
*
- * dequtask - data receive task
+ * @brief Data receive task
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c b/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c
index 4426dfe..195a7c8 100644
--- a/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c
@@ -92,7 +92,7 @@
/**
*
- * mailbox_test - mailbox transfer speed test
+ * @brief Mailbox transfer speed test
*
* @return N/A
*
@@ -143,7 +143,7 @@
/**
*
- * mailbox_put - write the number of data chunks into the mailbox
+ * @brief Write the number of data chunks into the mailbox
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c b/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c
index eaf1d78..270a9e1 100644
--- a/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c
+++ b/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c
@@ -48,7 +48,7 @@
/**
*
- * mailrecvtask - receive task
+ * @brief Receive task
*
* @return N/A
*
@@ -83,7 +83,7 @@
/**
*
- * mailbox_get - receive data portions from the specified mailbox
+ * @brief Receive data portions from the specified mailbox
*
* @return 0
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/master.c b/samples/microkernel/benchmark/app_kernel/src/master.c
index 167ccfb..b7ca657 100644
--- a/samples/microkernel/benchmark/app_kernel/src/master.c
+++ b/samples/microkernel/benchmark/app_kernel/src/master.c
@@ -63,7 +63,7 @@
/**
*
- * kbhit - check for keypress
+ * @brief Check for keypress
*
* @return 1 when a keyboard key is pressed, or 0 if no keyboard support
*
@@ -78,7 +78,7 @@
/**
*
- * init_output - prepares the test output
+ * @brief Prepares the test output
*
* @return N/A
*
@@ -101,7 +101,7 @@
/**
*
- * output_close - close output for the test
+ * @brief Close output for the test
*
* @return N/A
*
@@ -118,7 +118,7 @@
/**
*
- * BenchTask - perform all selected benchmarks
+ * @brief Perform all selected benchmarks
*
* @return N/A
*
@@ -173,7 +173,7 @@
/**
*
- * dummy_test - dummy test
+ * @brief Dummy test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/memmap_b.c b/samples/microkernel/benchmark/app_kernel/src/memmap_b.c
index 2b0fa7a..97ab0c6 100644
--- a/samples/microkernel/benchmark/app_kernel/src/memmap_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/memmap_b.c
@@ -38,7 +38,7 @@
/**
*
- * memorymap_test - memory map get/free test
+ * @brief Memory map get/free test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/mempool_b.c b/samples/microkernel/benchmark/app_kernel/src/mempool_b.c
index a95ced8..a627c3a 100644
--- a/samples/microkernel/benchmark/app_kernel/src/mempool_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/mempool_b.c
@@ -36,7 +36,7 @@
/**
*
- * mempool_test - memory pool get/free test
+ * @brief Memory pool get/free test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/mutex_b.c b/samples/microkernel/benchmark/app_kernel/src/mutex_b.c
index 84aa2a5..b09ee25 100644
--- a/samples/microkernel/benchmark/app_kernel/src/mutex_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/mutex_b.c
@@ -36,7 +36,7 @@
/**
*
- * mutex_test - mutex lock/unlock test
+ * @brief Mutex lock/unlock test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/nop_b.c b/samples/microkernel/benchmark/app_kernel/src/nop_b.c
index bdcf320..30a8597 100644
--- a/samples/microkernel/benchmark/app_kernel/src/nop_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/nop_b.c
@@ -40,7 +40,7 @@
/**
*
- * call_test - Kernel entry timing test
+ * @brief Kernel entry timing test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/pipe_b.c b/samples/microkernel/benchmark/app_kernel/src/pipe_b.c
index 6ca6688..a5d8dfd 100644
--- a/samples/microkernel/benchmark/app_kernel/src/pipe_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/pipe_b.c
@@ -109,7 +109,7 @@
/**
*
- * pipe_test - test the pipes transfer speed
+ * @brief Test the pipes transfer speed
*
* @return N/A
*
@@ -204,7 +204,7 @@
/**
*
- * pipeput - write a data portion to the pipe and measure time
+ * @brief Write a data portion to the pipe and measure time
*
* @return 0 on success, 1 on error
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/pipe_r.c b/samples/microkernel/benchmark/app_kernel/src/pipe_r.c
index 297dc98..1f2fc06 100644
--- a/samples/microkernel/benchmark/app_kernel/src/pipe_r.c
+++ b/samples/microkernel/benchmark/app_kernel/src/pipe_r.c
@@ -49,7 +49,7 @@
/**
*
- * piperecvtask - receive task
+ * @brief Receive task
*
* @return N/A
*
@@ -100,7 +100,7 @@
/**
*
- * pipeget - read a data portion from the pipe and measure time
+ * @brief Read a data portion from the pipe and measure time
*
* @return 0 on success, 1 on error
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/receiver.c b/samples/microkernel/benchmark/app_kernel/src/receiver.c
index 6151917..ca4f90e 100644
--- a/samples/microkernel/benchmark/app_kernel/src/receiver.c
+++ b/samples/microkernel/benchmark/app_kernel/src/receiver.c
@@ -50,7 +50,7 @@
/**
*
- * recvtask - main function of the task that receives data in the test
+ * @brief Main function of the task that receives data in the test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/sema_b.c b/samples/microkernel/benchmark/app_kernel/src/sema_b.c
index db59a47..5ac7bc1 100644
--- a/samples/microkernel/benchmark/app_kernel/src/sema_b.c
+++ b/samples/microkernel/benchmark/app_kernel/src/sema_b.c
@@ -37,7 +37,7 @@
/**
*
- * sema_test - semaphore signal speed test
+ * @brief Semaphore signal speed test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/app_kernel/src/sema_r.c b/samples/microkernel/benchmark/app_kernel/src/sema_r.c
index c56590e..5b57abf 100644
--- a/samples/microkernel/benchmark/app_kernel/src/sema_r.c
+++ b/samples/microkernel/benchmark/app_kernel/src/sema_r.c
@@ -39,7 +39,7 @@
/**
*
- * waittask - receive task (Wait task)
+ * @brief Receive task (Wait task)
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/boot_time/src/boot_time.c b/samples/microkernel/benchmark/boot_time/src/boot_time.c
index 3d92a7f..fb99b45 100644
--- a/samples/microkernel/benchmark/boot_time/src/boot_time.c
+++ b/samples/microkernel/benchmark/boot_time/src/boot_time.c
@@ -123,7 +123,7 @@
/**
*
- * main - nanokernel entry point
+ * @brief Nanokernel entry point
*
* @return N/A
*/
diff --git a/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c b/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c
index 0e79716..ff71603 100644
--- a/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c
+++ b/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c
@@ -130,7 +130,7 @@
/**
*
- * dummyIsr - dummy ISR
+ * @brief Dummy ISR
*
* @return N/A
*/
@@ -143,7 +143,7 @@
#ifdef TEST_reg
/**
*
- * isrDummyIntStub - static interrupt stub that invokes dummy ISR
+ * @brief Static interrupt stub that invokes dummy ISR
*
* NOTE: This is typically coded in assembly language, rather than C,
* to avoid the preamble code the compiler automatically generates. However,
@@ -164,7 +164,7 @@
/**
*
- * fgTaskEntry - entry function for foreground task
+ * @brief Entry function for foreground task
*
* This routine prints a message, then simply increments a global counter.
* (Gdb can be used to observe the counter as it increases.)
diff --git a/samples/microkernel/benchmark/latency_measure/src/main.c b/samples/microkernel/benchmark/latency_measure/src/main.c
index 0a6d39a..1c59766 100644
--- a/samples/microkernel/benchmark/latency_measure/src/main.c
+++ b/samples/microkernel/benchmark/latency_measure/src/main.c
@@ -46,7 +46,7 @@
/**
*
- * nanoTest - test latency of nanokernel
+ * @brief Test latency of nanokernel
*
* @return N/A
*
@@ -77,7 +77,7 @@
#ifdef CONFIG_NANOKERNEL
/**
*
- * main - nanokernel-only testing entry point
+ * @brief Nanokernel-only testing entry point
*
* @return N/A
*
@@ -104,7 +104,7 @@
/**
*
- * microTest - test latency of microkernel
+ * @brief Test latency of microkernel
*
* @return N/A
*
@@ -134,7 +134,7 @@
/**
*
- * main - microkernel testing entry point
+ * @brief Microkernel testing entry point
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c
index 1e7f140..06cd278 100644
--- a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c
+++ b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c
@@ -48,7 +48,7 @@
/**
*
- * latencyTestIsr - test ISR used to measure best case interrupt latency
+ * @brief Test ISR used to measure best case interrupt latency
*
* The interrupt handler gets the second timestamp.
*
@@ -67,7 +67,7 @@
/**
*
- * makeInt - interrupt preparation function
+ * @brief Interrupt preparation function
*
* Function makes all the test preparations: registers the interrupt handler,
* gets the first timestamp and invokes the software interrupt.
@@ -91,7 +91,7 @@
/**
*
- * microIntToTask - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c
index 4bce0a1..8e9f794 100644
--- a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c
+++ b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c
@@ -50,7 +50,7 @@
/**
*
- * latencyTestIsr - test ISR used to measure best case interrupt latency
+ * @brief Test ISR used to measure best case interrupt latency
*
* The interrupt handler gets the second timestamp.
*
@@ -69,7 +69,7 @@
/**
*
- * microInt - software interrupt generating task
+ * @brief Software interrupt generating task
*
* Lower priority task that, when starts, wats for the semaphore. When gets
* released by the main task, sets up the interrupt handler and generates the
@@ -90,7 +90,7 @@
/**
*
- * microIntToTaskEvt - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c b/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c
index 92468a2..c75e88b 100644
--- a/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c
+++ b/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c
@@ -55,7 +55,7 @@
/**
*
- * microSemaLockUnlock - the function tests semaphore lock/unlock time
+ * @brief The function tests semaphore lock/unlock time
*
* The routine performs unlock the quite amount of semaphores and then
* acquires them in order to measure the necessary time.
@@ -105,7 +105,7 @@
/**
*
- * microMutexLockUnlock - test for the multiple mutex lock/unlock time
+ * @brief Test for the multiple mutex lock/unlock time
*
* The routine performs multiple mutex locks and then multiple mutex
* unlocks to measure the necessary time.
diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c b/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c
index 57d727e..d769804 100644
--- a/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c
+++ b/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c
@@ -52,7 +52,7 @@
/**
*
- * yieldingTask - helper task for measuring task switch latency using yield
+ * @brief Helper task for measuring task switch latency using yield
*
* This task is define in .mdef as SEMYIELDTSK
*
@@ -71,7 +71,7 @@
/**
*
- * microTaskSwitchYield - entry point for task context switch using yield test
+ * @brief Entry point for task context switch using yield test
*
* @return N/A
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c b/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c
index 56c93bb..db2a984 100644
--- a/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c
+++ b/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c
@@ -90,7 +90,7 @@
/**
*
- * fiberWaiter - check the time when it gets executed after the semaphore
+ * @brief Check the time when it gets executed after the semaphore
*
* Fiber starts, waits on semaphore. When the interrupt handler releases
* the semaphore, fiber measures the time.
@@ -112,7 +112,7 @@
/**
*
- * nanoCtxSwitch - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int.c b/samples/microkernel/benchmark/latency_measure/src/nano_int.c
index 88b2f4b..88ef507 100644
--- a/samples/microkernel/benchmark/latency_measure/src/nano_int.c
+++ b/samples/microkernel/benchmark/latency_measure/src/nano_int.c
@@ -50,7 +50,7 @@
/**
*
- * latencyTestIsr - test ISR used to measure best case interrupt latency
+ * @brief Test ISR used to measure best case interrupt latency
*
* The interrupt handler gets the second timestamp.
*
@@ -68,7 +68,7 @@
/**
*
- * fiberInt - interrupt preparation fiber
+ * @brief Interrupt preparation fiber
*
* Fiber makes all the test preparations: registers the interrupt handler,
* gets the first timestamp and invokes the software interrupt.
@@ -87,7 +87,7 @@
/**
*
- * nanoIntLatency - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c b/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c
index 1389cab..b5ac6a7 100644
--- a/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c
+++ b/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c
@@ -51,7 +51,7 @@
/**
*
- * nanoIntLockUnlock - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c
index 29ccd12..b4151fc 100644
--- a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c
+++ b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c
@@ -52,7 +52,7 @@
/**
*
- * latencyTestIsr - test ISR used to measure best case interrupt latency
+ * @brief Test ISR used to measure best case interrupt latency
*
* The interrupt handler gets the second timestamp.
*
@@ -71,7 +71,7 @@
/**
*
- * fiberInt - interrupt preparation fiber
+ * @brief Interrupt preparation fiber
*
* Fiber makes all the test preparations: registers the interrupt handler,
* gets the first timestamp and invokes the software interrupt.
@@ -95,7 +95,7 @@
/**
*
- * nanoIntToFiber - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c
index eebd316..fad46c3 100644
--- a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c
+++ b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c
@@ -63,7 +63,7 @@
/**
*
- * latencyTestIsr - test ISR used to measure best case interrupt latency
+ * @brief Test ISR used to measure best case interrupt latency
*
* The interrupt handler gets the second timestamp.
*
@@ -82,7 +82,7 @@
/**
*
- * fiberInt - interrupt preparation fiber
+ * @brief Interrupt preparation fiber
*
* Fiber makes all the test preparations: registers the interrupt handler,
* gets the first timestamp and invokes the software interrupt.
@@ -101,7 +101,7 @@
/**
*
- * fiberWaiter - check the time when it gets executed after the semaphore
+ * @brief Check the time when it gets executed after the semaphore
*
* Fiber starts, waits on semaphore. When the interrupt handler releases
* the semaphore, fiber measures the time.
@@ -119,7 +119,7 @@
/**
*
- * nanoIntToFiberSem - the test main function
+ * @brief The test main function
*
* @return 0 on success
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/raise_int.c b/samples/microkernel/benchmark/latency_measure/src/raise_int.c
index df3d79d..f7d2447 100644
--- a/samples/microkernel/benchmark/latency_measure/src/raise_int.c
+++ b/samples/microkernel/benchmark/latency_measure/src/raise_int.c
@@ -1390,7 +1390,7 @@
/**
*
- * raiseInt - generate a software interrupt
+ * @brief Generate a software interrupt
*
* This routine will call one of the genInt functions based upon the
* value passed to it (which is essentially the interrupt vector number).
@@ -1409,7 +1409,7 @@
#include <arch/cpu.h>
/**
*
- * raiseInt - generate a software interrupt
+ * @brief Generate a software interrupt
*
* Trigger via NVIC. <id> is the IRQ number.
*
diff --git a/samples/microkernel/benchmark/latency_measure/src/utils.c b/samples/microkernel/benchmark/latency_measure/src/utils.c
index d5c7807..6f49fa6 100644
--- a/samples/microkernel/benchmark/latency_measure/src/utils.c
+++ b/samples/microkernel/benchmark/latency_measure/src/utils.c
@@ -58,7 +58,7 @@
/**
*
- * initSwInterrupt - initialize the interrupt handler
+ * @brief Initialize the interrupt handler
*
* Function initializes the interrupt handler with the pointer to the function
* provided as an argument. It sets up allocated interrupt vector, pointer to
@@ -80,7 +80,7 @@
/**
*
- * setSwInterrupt - set the new ISR for software interrupt
+ * @brief Set the new ISR for software interrupt
*
* The routine shange the ISR for the fully connected interrupt to the routine
* provided. This routine can be invoked only after the interrupt has been
@@ -99,7 +99,7 @@
/**
*
- * raiseIntFunc - generate a software interrupt
+ * @brief Generate a software interrupt
*
* This routine will call one of the generate SW interrupt functions based upon
* the current vector assigned by the initSwInterrupt() function.
diff --git a/samples/microkernel/benchmark/latency_measure/src/utils.h b/samples/microkernel/benchmark/latency_measure/src/utils.h
index 9bf3522..37ca0d3 100644
--- a/samples/microkernel/benchmark/latency_measure/src/utils.h
+++ b/samples/microkernel/benchmark/latency_measure/src/utils.h
@@ -59,7 +59,7 @@
/**
*
- * printDashLine - print dash line
+ * @brief Print dash line
*
* @return N/A
*
@@ -116,7 +116,7 @@
/**
*
- * initSwInterrupt - initialize the interrupt handler
+ * @brief Initialize the interrupt handler
*
* Function initializes the interrupt handler with the pointer to the function
* provided as an argument. It sets up allocated interrupt vector, pointer to
@@ -131,7 +131,7 @@
/**
*
- * setSwInterrupt - set the new ISR for software interrupt
+ * @brief Set the new ISR for software interrupt
*
* The routine shange the ISR for the fully connected interrupt to the routine
* provided. This routine can be invoked only after the interrupt has been
diff --git a/samples/microkernel/test/test_critical/src/critical.c b/samples/microkernel/test/test_critical/src/critical.c
index 2db0c62..fe52a3b 100644
--- a/samples/microkernel/test/test_critical/src/critical.c
+++ b/samples/microkernel/test/test_critical/src/critical.c
@@ -47,7 +47,7 @@
/**
*
- * criticalRtn - routine to be called from K_swapper()
+ * @brief Routine to be called from K_swapper()
*
* This routine increments the global variable <criticalVar>.
*
@@ -66,7 +66,7 @@
/**
*
- * criticalLoop - common code for invoking task_offload_to_fiber()
+ * @brief Common code for invoking task_offload_to_fiber()
*
* @param count number of critical section calls made thus far
*
@@ -88,7 +88,7 @@
/**
*
- * AlternateTask - alternate task
+ * @brief Alternate task
*
* This routine calls task_offload_to_fiber() many times.
*
@@ -112,7 +112,7 @@
/**
*
- * RegressionTask - regression task
+ * @brief Regression task
*
* This routine calls task_offload_to_fiber() many times. It also checks to
* ensure that the number of times it is called matches the global variable
diff --git a/samples/microkernel/test/test_events/src/events.c b/samples/microkernel/test/test_events/src/events.c
index 0221f5b..a238a60 100644
--- a/samples/microkernel/test/test_events/src/events.c
+++ b/samples/microkernel/test/test_events/src/events.c
@@ -67,7 +67,7 @@
/**
*
- * isr_event_signal_handler - ISR handler to signal an event
+ * @brief ISR handler to signal an event
*
* @return N/A
*/
@@ -81,7 +81,7 @@
/**
*
- * releaseTestFiber - release the test fiber
+ * @brief Release the test fiber
*
* @return N/A
*/
@@ -93,7 +93,7 @@
/**
*
- * microObjectsInit - initialize objects used in this microkernel test suite
+ * @brief Initialize objects used in this microkernel test suite
*
* @return N/A
*/
@@ -113,7 +113,7 @@
/**
*
- * eventNoWaitTest - test the task_event_recv() API
+ * @brief Test the task_event_recv() API
*
* There are three cases to be tested here. The first is for testing an invalid
* event. The second is for testing for an event when there is one. The third
@@ -159,7 +159,7 @@
/**
*
- * eventWaitTest - test the task_event_recv_wait() API
+ * @brief Test the task_event_recv_wait() API
*
* This test checks task_event_recv_wait() against the following cases:
* 1. There is already an event waiting (signalled from a task and ISR).
@@ -231,7 +231,7 @@
/**
*
- * eventTimeoutTest - test the task_event_recv_wait_timeout() API
+ * @brief Test the task_event_recv_wait_timeout() API
*
* This test checks task_event_recv_wait_timeout() against the following cases:
* 1. The current task times out while waiting for the event.
@@ -282,7 +282,7 @@
/**
*
- * isrEventSignalTest - test the isr_event_send() API
+ * @brief Test the isr_event_send() API
*
* Although other tests have done some testing using isr_event_send(), none
* of them have demonstrated that signalling an event more than once does not
@@ -324,7 +324,7 @@
/**
*
- * fiberEventSignalTest - test the fiber_event_send() API
+ * @brief Test the fiber_event_send() API
*
* Signalling an event by fiber_event_send() more than once does not "queue"
* events. That is, should two or more signals of the same event occur before
@@ -361,7 +361,7 @@
/**
*
- * eventHandler - handler to run on EVENT_ID event
+ * @brief Handler to run on EVENT_ID event
*
* @param event signalled event
*
@@ -379,7 +379,7 @@
/**
*
- * altEventHandler - handler to run on ALT_EVENT event
+ * @brief Handler to run on ALT_EVENT event
*
* @param event signalled event
*
@@ -397,7 +397,7 @@
/**
*
- * eventSignalHandlerTest - test the task_event_set_handler() API
+ * @brief Test the task_event_set_handler() API
*
* This test checks that the event handler is set up properly when
* task_event_set_handler() is called. It shows that event handlers are tied
@@ -520,7 +520,7 @@
/**
*
- * AlternateTask - alternate task to signal various events to a waiting task
+ * @brief Alternate task to signal various events to a waiting task
*
* @return N/A
*/
@@ -558,7 +558,7 @@
/**
*
- * RegressionTask - main entry point to the test suite
+ * @brief Main entry point to the test suite
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_events/src/test_fiber.c b/samples/microkernel/test/test_events/src/test_fiber.c
index 86dc95e..33d96e3 100644
--- a/samples/microkernel/test/test_events/src/test_fiber.c
+++ b/samples/microkernel/test/test_events/src/test_fiber.c
@@ -51,7 +51,7 @@
/**
*
- * testFiberEntry - the test fiber entry function
+ * @brief The test fiber entry function
*
* Fiber waits on the semaphore controlled by the test task
* It signals the event for the eventWaitTest() function
@@ -84,7 +84,7 @@
/**
*
- * testFiberInit - initializes variables and starts the test fiber
+ * @brief Initializes variables and starts the test fiber
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_fifo/src/fifo.c b/samples/microkernel/test/test_fifo/src/fifo.c
index 8fcb9ed..8ac43c2 100644
--- a/samples/microkernel/test/test_fifo/src/fifo.c
+++ b/samples/microkernel/test/test_fifo/src/fifo.c
@@ -64,7 +64,7 @@
/**
*
- * initMyData - initialize data array
+ * @brief Initialize data array
*
* This routine initializes the myData array used in the FIFO tests.
*
@@ -80,7 +80,7 @@
/**
*
- * printMyData - print data array
+ * @brief Print data array
*
* This routine prints myData array.
*
@@ -97,7 +97,7 @@
/**
*
- * verifyRetValue - verify return value
+ * @brief Verify return value
*
* This routine verifies current value against expected value
* and returns true if they are the same.
@@ -115,7 +115,7 @@
/**
*
- * initMicroObjects - initialize microkernel objects
+ * @brief Initialize microkernel objects
*
* This routine initializes the microkernel objects used in the FIFO tests.
*
@@ -130,7 +130,7 @@
/**
*
- * fillFIFO - fills up the FIFO queue
+ * @brief Fills up the FIFO queue
*
* This routine fills the FIFO queue with myData array. This assumes the
* queue is empty before we put in elements.
@@ -187,7 +187,7 @@
/**
*
- * MicroTestFifoTask - task to test FIFO queue
+ * @brief Task to test FIFO queue
*
* This routine is run in three context switches:
* - it puts an element to the FIFO queue
@@ -272,7 +272,7 @@
/**
*
- * verifyQueueData - Verifies data in queue is correct
+ * @brief Verifies data in queue is correct
*
* This routine assumes that the queue is full when this function is called.
* It counts the number of elements in the queue, dequeues elements and verifies
@@ -350,7 +350,7 @@
/**
*
- * RegressionTask - main task to test FIFO queue
+ * @brief Main task to test FIFO queue
*
* This routine initializes data, fills the FIFO queue and verifies the
* data in the queue is in correct order when items are being dequeued.
diff --git a/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h b/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h
index e286a22..f14726e 100644
--- a/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h
+++ b/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h
@@ -42,7 +42,7 @@
/**
*
- * _LoadAllFloatRegisters - load all floating point registers
+ * @brief Load all floating point registers
*
* This function loads ALL floating point registers from the memory buffer
* specified by <pFromBuffer>. It is expected that a subsequent call to
@@ -111,7 +111,7 @@
/**
*
- * _LoadThenStoreAllFloatRegisters - load then dump all float registers to memory
+ * @brief Load then dump all float registers to memory
*
* This function loads ALL floating point registers from the memory buffer
* specified by <pFromToBuffer>, and then stores them back to that buffer.
@@ -166,7 +166,7 @@
/**
*
- * _StoreAllFloatRegisters - dump all floating point registers to memory
+ * @brief Dump all floating point registers to memory
*
* This function stores ALL floating point registers to the memory buffer
* specified by <pToBuffer>. It is expected that a previous invocation of
@@ -203,7 +203,7 @@
/**
*
- * _StoreNonVolatileFloatRegisters - dump non-volatile FP registers to memory
+ * @brief Dump non-volatile FP registers to memory
*
* This routine is called by a high priority context after resuming execution
* from calling a primitive that will pend and thus result in a co-operative
diff --git a/samples/microkernel/test/test_fp_sharing/src/main.c b/samples/microkernel/test/test_fp_sharing/src/main.c
index 0850342..9e1e779 100644
--- a/samples/microkernel/test/test_fp_sharing/src/main.c
+++ b/samples/microkernel/test/test_fp_sharing/src/main.c
@@ -140,7 +140,7 @@
/**
*
* main -
- * load_store_low - low priority FPU load/store context
+ * @brief Low priority FPU load/store context
*
* @return N/A
*/
@@ -308,7 +308,7 @@
/**
*
- * load_store_high - high priority FPU load/store context
+ * @brief High priority FPU load/store context
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_fp_sharing/src/pi.c b/samples/microkernel/test/test_fp_sharing/src/pi.c
index c9d1313..4cc0422 100644
--- a/samples/microkernel/test/test_fp_sharing/src/pi.c
+++ b/samples/microkernel/test/test_fp_sharing/src/pi.c
@@ -75,7 +75,7 @@
/**
*
- * calculate_pi_low - entry point for the low priority pi compute task
+ * @brief Entry point for the low priority pi compute task
*
* @return N/A
*/
@@ -118,7 +118,7 @@
/**
*
- * calculate_pi_high - entry point for the high priority pi compute task
+ * @brief Entry point for the high priority pi compute task
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_libs/src/libraries.c b/samples/microkernel/test/test_libs/src/libraries.c
index 8402d9e..d556659 100644
--- a/samples/microkernel/test/test_libs/src/libraries.c
+++ b/samples/microkernel/test/test_libs/src/libraries.c
@@ -59,7 +59,7 @@
/**
*
- * limitsTest - test implementation-defined constants library
+ * @brief Test implementation-defined constants library
*
* @return TC_PASS or TC_FAIL
*/
@@ -77,7 +77,7 @@
/**
*
- * stdboolTest - test boolean types and values library
+ * @brief Test boolean types and values library
*
* @return TC_PASS or TC_FAIL
*/
@@ -103,7 +103,7 @@
/**
*
- * stddefTest - test standard type definitions library
+ * @brief Test standard type definitions library
*
* @return TC_PASS or TC_FAIL
*/
@@ -129,7 +129,7 @@
/**
*
- * stdintTest - test integer types library
+ * @brief Test integer types library
*
* @return TC_PASS or TC_FAIL
*/
@@ -155,7 +155,7 @@
/**
*
- * memset_test - test string memset
+ * @brief Test string memset
*
* @return TC_PASS or TC_FAIL
*/
@@ -176,7 +176,7 @@
/**
*
- * strlen_test - test string length function
+ * @brief Test string length function
*
* @return TC_PASS or TC_FAIL
*/
@@ -198,7 +198,7 @@
/**
*
- * strcmp_test - test string compare function
+ * @brief Test string compare function
*
* @return TC_PASS or TC_FAIL
*/
@@ -236,7 +236,7 @@
/**
*
- * strncmp_test - test string N compare function
+ * @brief Test string N compare function
*
* @return TC_PASS or TC_FAIL
*/
@@ -275,7 +275,7 @@
/**
*
- * strcpy_test - test string copy function
+ * @brief Test string copy function
*
* @return TC_PASS or TC_FAIL
*/
@@ -298,7 +298,7 @@
/**
*
- * strncpy_test - test string N copy function
+ * @brief Test string N copy function
*
* @return TC_PASS or TC_FAIL
*/
@@ -322,7 +322,7 @@
/**
*
- * strchr_test - test string scanning function
+ * @brief Test string scanning function
*
* @return TC_PASS or TC_FAIL
*/
@@ -353,7 +353,7 @@
/**
*
- * memcmp_test - test memory comparison function
+ * @brief Test memory comparison function
*
* @return TC_PASS or TC_FAIL
*/
@@ -381,7 +381,7 @@
/**
*
- * stringTest - test string operations library
+ * @brief Test string operations library
* * @return TC_PASS or TC_FAIL
*/
@@ -400,7 +400,7 @@
/**
*
- * RegressionTask - main task in the test suite
+ * @brief Main task in the test suite
*
* This is the entry point to the main task used by the standard libraries test
* suite. It tests each library in turn until a failure is detected or all
diff --git a/samples/microkernel/test/test_libs/src/main.c b/samples/microkernel/test/test_libs/src/main.c
index 679a215..744e66b 100644
--- a/samples/microkernel/test/test_libs/src/main.c
+++ b/samples/microkernel/test/test_libs/src/main.c
@@ -63,7 +63,7 @@
/**
*
- * RegressionTaskEntry - entry point for RegressionTask
+ * @brief Entry point for RegressionTask
*
* This routine signals "task done" or "task fail", based on the return code of
* RegressionTask.
@@ -80,7 +80,7 @@
/**
*
- * MonitorTaskEntry - entry point for MonitorTask
+ * @brief Entry point for MonitorTask
*
* This routine keeps tabs on the progress of the tasks doing the actual testing
* and generates the final test case summary message.
diff --git a/samples/microkernel/test/test_mail/src/mail.c b/samples/microkernel/test/test_mail/src/mail.c
index 57e9a32..0294fd8 100644
--- a/samples/microkernel/test/test_mail/src/mail.c
+++ b/samples/microkernel/test/test_mail/src/mail.c
@@ -86,7 +86,7 @@
/**
*
- * setMsg_Sender - sets various fields in the message for the sender
+ * @brief Sets various fields in the message for the sender
*
* Sets the following fields in the message:
* rx_task to receiverTask - destination for the message
@@ -114,7 +114,7 @@
/**
*
- * setMsg_Receiver - sets various fields in the message for the receiver
+ * @brief Sets various fields in the message for the receiver
*
* Sets the following fields in the message:
* rx_data to NULL - to allow message transfer to occur
@@ -145,7 +145,7 @@
/**
*
- * setMsg_RecvBuf - sets rx_data field in msg and clears buffer
+ * @brief Sets rx_data field in msg and clears buffer
*
* @param inMsg The message being received.
* @param inBuffer Incoming data area.
@@ -165,7 +165,7 @@
/**
*
- * MsgSenderTask - task that tests sending of mailbox messages
+ * @brief Task that tests sending of mailbox messages
*
* This routine exercises the task_mbox_put[_wait[_timeout]] APIs.
*
@@ -360,7 +360,7 @@
/**
*
- * MsgRcvrTask - task that tests receiving of mailbox messages
+ * @brief Task that tests receiving of mailbox messages
*
* This routine exercises the task_mbox_get[_wait[_timeout]] and task_mbox_data_get[xxx] APIs.
*
diff --git a/samples/microkernel/test/test_mail/src/main.c b/samples/microkernel/test/test_mail/src/main.c
index 5c705a7..8c7830a 100644
--- a/samples/microkernel/test/test_mail/src/main.c
+++ b/samples/microkernel/test/test_mail/src/main.c
@@ -71,7 +71,7 @@
/**
*
- * MsgSenderTaskEntry - entry point for MsgSenderTask
+ * @brief Entry point for MsgSenderTask
*
* This routine signals "task done" or "task fail", based on the return code of
* MsgSenderTask.
@@ -88,7 +88,7 @@
/**
*
- * MsgRcvrTaskEntry - entry point for MsgRcvrTask
+ * @brief Entry point for MsgRcvrTask
*
* This routine signals "task done" or "task fail", based on the return code of
* MsgRcvrTask.
@@ -105,7 +105,7 @@
/**
*
- * MonitorTaskEntry - entry point for MonitorTask
+ * @brief Entry point for MonitorTask
*
* This routine keeps tabs on the progress of the tasks doing the actual testing
* and generates the final test case summary message.
diff --git a/samples/microkernel/test/test_map/src/map.c b/samples/microkernel/test/test_map/src/map.c
index a29df5a..cfae858 100644
--- a/samples/microkernel/test/test_map/src/map.c
+++ b/samples/microkernel/test/test_map/src/map.c
@@ -62,7 +62,7 @@
/**
*
- * verifyRetValue - verify return value
+ * @brief Verify return value
*
* This routine verifies current value against expected value
* and returns true if they are the same.
@@ -81,7 +81,7 @@
/**
*
- * HelperTask - helper task
+ * @brief Helper task
*
* This routine gets all blocks from the memory map. It uses semaphores
* SEM_REGRESDONE and SEM_HELPERDONE to synchronize between different parts
@@ -143,7 +143,7 @@
/**
*
- * testMapGetAllBlocks - get all blocks from the memory map
+ * @brief Get all blocks from the memory map
*
* Get all blocks from the memory map. It also tries to get one more block
* from the map after the map is empty to verify the error return code.
@@ -215,7 +215,7 @@
/**
*
- * testMapFreeAllBlocks - free all memeory blocks
+ * @brief Free all memeory blocks
*
* This routine frees all memory blocks and also verifies that the number of
* blocks used are correct.
@@ -275,7 +275,7 @@
/**
*
- * printPointers - print the pointers
+ * @brief Print the pointers
*
* This routine prints out the pointers.
*
@@ -297,7 +297,7 @@
/**
*
- * RegressionTask - main task to test task_mem_map_xxx interfaces
+ * @brief Main task to test task_mem_map_xxx interfaces
*
* This routine calls testMapGetAllBlocks() to get all memory blocks from the
* map and calls testMapFreeAllBlocks() to free all memory blocks. It also
diff --git a/samples/microkernel/test/test_mutex/src/mutex.c b/samples/microkernel/test/test_mutex/src/mutex.c
index b3ca684..1607c4b 100644
--- a/samples/microkernel/test/test_mutex/src/mutex.c
+++ b/samples/microkernel/test/test_mutex/src/mutex.c
@@ -237,7 +237,7 @@
/**
*
- * RegressionTask - main task to test task_mutex_xxx interfaces
+ * @brief Main task to test task_mutex_xxx interfaces
*
* This task will lock on Mutex1, Mutex2, Mutex3 and Mutex4.
*
diff --git a/samples/microkernel/test/test_pipe/src/main.c b/samples/microkernel/test/test_pipe/src/main.c
index 38674e6..d1cd05f 100644
--- a/samples/microkernel/test/test_pipe/src/main.c
+++ b/samples/microkernel/test/test_pipe/src/main.c
@@ -65,7 +65,7 @@
/**
*
- * RegressionTaskEntry - entry point for RegressionTask
+ * @brief Entry point for RegressionTask
*
* This routine signals "task done" or "task fail", based on the return code of
* RegressionTask.
@@ -82,7 +82,7 @@
/**
*
- * AlternateTaskEntry - entry point for AlternateTask
+ * @brief Entry point for AlternateTask
*
* This routine signals "task done" or "task fail", based on the return code of
* AlternateTask.
@@ -99,7 +99,7 @@
/**
*
- * MonitorTaskEntry - entry point for MonitorTask
+ * @brief Entry point for MonitorTask
*
* This routine keeps tabs on the progress of the tasks doing the actual testing
* and generates the final test case summary message.
diff --git a/samples/microkernel/test/test_pipe/src/pipe.c b/samples/microkernel/test/test_pipe/src/pipe.c
index 2fb2d90..065d4d7 100644
--- a/samples/microkernel/test/test_pipe/src/pipe.c
+++ b/samples/microkernel/test/test_pipe/src/pipe.c
@@ -158,7 +158,7 @@
/**
*
- * microObjectsInit - initialize objects used in this microkernel test suite
+ * @brief Initialize objects used in this microkernel test suite
*
* @return N/A
*/
@@ -174,7 +174,7 @@
/**
*
- * receiveBufferCheck - check the contents of the receive buffer
+ * @brief Check the contents of the receive buffer
*
* @param buffer pointer to buffer to check
* @param size number of bytes to check
@@ -197,7 +197,7 @@
/**
*
- * pipePutHelperWork - helper routine to pipePutTest()
+ * @brief Helper routine to pipePutTest()
*
* @param singleItems testcase list (one item in the pipe)
* @param nSingles number of items in testcase
@@ -297,7 +297,7 @@
/**
*
- * pipePutHelper - helper routine to pipePutTest()
+ * @brief Helper routine to pipePutTest()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -332,7 +332,7 @@
/**
*
- * pipePutTestWork - test task_pipe_put()
+ * @brief Test task_pipe_put()
*
* This routine tests the task_pipe_put() API.
*
@@ -421,7 +421,7 @@
/**
*
- * pipePutTest - test task_pipe_put()
+ * @brief Test task_pipe_put()
*
* This routine tests the task_pipe_put() API.
*
@@ -458,7 +458,7 @@
/**
*
- * pipePutWaitHelper - help test task_pipe_put_wait()
+ * @brief Help test task_pipe_put_wait()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -522,7 +522,7 @@
/**
*
- * pipePutWaitTest - test task_pipe_put_wait()
+ * @brief Test task_pipe_put_wait()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -582,7 +582,7 @@
/**
*
- * pipePutTimeoutHelper - test task_pipe_get_wait_timeout()
+ * @brief Test task_pipe_get_wait_timeout()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -646,7 +646,7 @@
/**
*
- * pipePutTimeoutTest - test task_pipe_put_wait_timeout()
+ * @brief Test task_pipe_put_wait_timeout()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -726,7 +726,7 @@
/**
*
- * pipeGetTest - routine to test task_pipe_get()
+ * @brief Routine to test task_pipe_get()
*
* This routine tests the task_pipe_get() API. Some of this functionality
* has already been tested while testing task_pipe_put(). As a result, the
@@ -775,7 +775,7 @@
/**
*
- * pipeGetWaitHelperWork - test task_pipe_get_wait()
+ * @brief Test task_pipe_get_wait()
*
* @param items testcase list for task_pipe_get_wait()
* @param nItems number of items in list
@@ -812,7 +812,7 @@
/**
*
- * pipeGetWaitHelper - test task_pipe_get_wait()
+ * @brief Test task_pipe_get_wait()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -840,7 +840,7 @@
/**
*
- * pipeGetWaitTestWork - test task_pipe_get_wait()
+ * @brief Test task_pipe_get_wait()
*
* @param items testcase list for task_pipe_get_wait()
* @param nItems number of items in list
@@ -876,7 +876,7 @@
/**
*
- * pipeGetWaitTest - test task_pipe_get_wait()
+ * @brief Test task_pipe_get_wait()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -912,7 +912,7 @@
/**
*
- * pipeGetTimeoutTest - test remaining task_pipe_get_wait_timeout() functionality
+ * @brief Test remaining task_pipe_get_wait_timeout() functionality
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -942,7 +942,7 @@
/**
*
- * AlternateTask - alternate task in the test suite
+ * @brief Alternate task in the test suite
*
* This routine runs at a lower priority than RegressionTask().
*
@@ -989,7 +989,7 @@
/**
*
- * RegressionTask - main task in the test suite
+ * @brief Main task in the test suite
*
* This is the entry point to the pipe test suite.
*
diff --git a/samples/microkernel/test/test_pool/src/pool.c b/samples/microkernel/test/test_pool/src/pool.c
index 301695c..de3d483 100644
--- a/samples/microkernel/test/test_pool/src/pool.c
+++ b/samples/microkernel/test/test_pool/src/pool.c
@@ -111,7 +111,7 @@
/**
*
- * blockCompare - compare the two blocks
+ * @brief Compare the two blocks
*
* @return 0 if the same, non-zero if not the same
*/
@@ -135,7 +135,7 @@
/**
*
- * poolBlockGetFunc - wrapper for task_mem_pool_alloc()
+ * @brief Wrapper for task_mem_pool_alloc()
*
* @return task_mem_pool_alloc() return value
*/
@@ -150,7 +150,7 @@
/**
*
- * poolBlockGetWFunc - wrapper for task_mem_pool_alloc_wait()
+ * @brief Wrapper for task_mem_pool_alloc_wait()
*
* @return task_mem_pool_alloc_wait() return value
*/
@@ -165,7 +165,7 @@
/**
*
- * poolBlockGetWTFunc - wrapper for task_mem_pool_alloc_wait_timeout()
+ * @brief Wrapper for task_mem_pool_alloc_wait_timeout()
*
* @return task_mem_pool_alloc_wait_timeout() return value
*/
@@ -178,7 +178,7 @@
/**
*
- * freeBlocks - free any blocks allocated in the test set
+ * @brief Free any blocks allocated in the test set
*
* @return N/A
*/
@@ -196,7 +196,7 @@
/**
*
- * poolBlockGetWork - perform the work of getting blocks
+ * @brief Perform the work of getting blocks
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -223,7 +223,7 @@
/**
*
- * poolBlockGetTest - test the task_mem_pool_alloc() API
+ * @brief Test the task_mem_pool_alloc() API
*
* The pool is 4 kB in size.
*
@@ -258,7 +258,7 @@
/**
*
- * HelperTask - helper task to poolBlockGetTimeoutTest()
+ * @brief Helper task to poolBlockGetTimeoutTest()
*
* @return N/A
*/
@@ -273,7 +273,7 @@
/**
*
- * poolBlockGetTimeoutTest - test task_mem_pool_alloc_wait_timeout()
+ * @brief Test task_mem_pool_alloc_wait_timeout()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -368,7 +368,7 @@
/**
*
- * DefragTask - task responsible for defragmenting the pool POOL_ID
+ * @brief Task responsible for defragmenting the pool POOL_ID
*
* @return N/A
*/
@@ -433,7 +433,7 @@
/**
*
- * AlternateTask - alternate task in the test suite
+ * @brief Alternate task in the test suite
*
* This routine runs at a lower priority than RegressionTask().
*
@@ -453,7 +453,7 @@
/**
*
- * RegressionTask - main task in the test suite
+ * @brief Main task in the test suite
*
* This is the entry point to the memory pool test suite.
*
diff --git a/samples/microkernel/test/test_rand32/src/test-rand32.c b/samples/microkernel/test/test_rand32/src/test-rand32.c
index d52e5cd..b2d8967 100644
--- a/samples/microkernel/test/test_rand32/src/test-rand32.c
+++ b/samples/microkernel/test/test_rand32/src/test-rand32.c
@@ -43,7 +43,7 @@
/**
*
- * RegressionTaskEntry - regression test's entry point
+ * @brief Regression test's entry point
*
*
* @return N/A
diff --git a/samples/microkernel/test/test_sema/src/main.c b/samples/microkernel/test/test_sema/src/main.c
index 4790858..5974b21 100644
--- a/samples/microkernel/test/test_sema/src/main.c
+++ b/samples/microkernel/test/test_sema/src/main.c
@@ -93,7 +93,7 @@
/**
*
- * RegressionTaskEntry - entry point for RegressionTask
+ * @brief Entry point for RegressionTask
*
* This routine signals "task done" or "task fail", based on the return code of
* RegressionTask.
@@ -110,7 +110,7 @@
/**
*
- * AlternateTaskEntry - entry point for AlternateTask
+ * @brief Entry point for AlternateTask
*
* This routine signals "task done" or "task fail", based on the return code of
* MsgRcvrTask.
@@ -127,7 +127,7 @@
/**
*
- * HighPriTaskEntry - entry point for HighPriTask
+ * @brief Entry point for HighPriTask
*
* This routine signals "task done" or "task fail", based on the return code of
* HighPriTask.
@@ -144,7 +144,7 @@
/**
*
- * LowPriTaskEntry - entry point for LowPriTask
+ * @brief Entry point for LowPriTask
*
* This routine signals "task done" or "task fail", based on the return code of
* LowPriTask.
@@ -161,7 +161,7 @@
/**
*
- * testIsrHandler - ISR that gives specified semaphore
+ * @brief ISR that gives specified semaphore
*
* @param isrData pointer to semaphore to be given
*
@@ -175,7 +175,7 @@
/**
*
- * trigger_isrSemaSignal - generate interrupt that gives specified semaphore
+ * @brief Generate interrupt that gives specified semaphore
*
* @param semaphore semaphore to be given
*
@@ -190,7 +190,7 @@
/**
*
- * releaseTestFiber - release the test fiber
+ * @brief Release the test fiber
*
* @return N/A
*/
@@ -202,7 +202,7 @@
/**
*
- * testInterruptsInit - initialize interrupt-related code
+ * @brief Initialize interrupt-related code
*
* Binds an ISR to the interrupt vector used to give semaphores from interrupt
* level.
@@ -222,7 +222,7 @@
/**
*
- * MonitorTaskEntry - entry point for MonitorTask
+ * @brief Entry point for MonitorTask
*
* This routine keeps tabs on the progress of the tasks doing the actual testing
* and generates the final test case summary message.
diff --git a/samples/microkernel/test/test_sema/src/sema.c b/samples/microkernel/test/test_sema/src/sema.c
index 6cbf895..9cda150 100644
--- a/samples/microkernel/test/test_sema/src/sema.c
+++ b/samples/microkernel/test/test_sema/src/sema.c
@@ -72,7 +72,7 @@
/**
*
- * simpleSemaTest - signal semaphore that has no waiting tasks from ISR
+ * @brief Signal semaphore that has no waiting tasks from ISR
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -165,7 +165,7 @@
/**
*
- * simpleSemaWaitTest - test the waiting of a semaphore
+ * @brief Test the waiting of a semaphore
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -223,7 +223,7 @@
/**
*
- * simpleGroupTest - test for a group of semaphores
+ * @brief Test for a group of semaphores
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -303,7 +303,7 @@
/**
*
- * simpleGroupWaitTest - test a group of semaphores with waiting
+ * @brief Test a group of semaphores with waiting
*
* This routine tests the waiting feature on a group of semaphores. Note that
* timing out on a wait has already been tested so it need not be done again.
@@ -366,7 +366,7 @@
/**
*
- * simpleFiberSemTest - test semaphore signaling from fiber
+ * @brief Test semaphore signaling from fiber
*
* Routine starts a fiber and does the following tests:
* - fiber signals the semaphore N times, task checks that task_sem_count_get is N
@@ -421,7 +421,7 @@
/**
*
- * HighPriTask - a high priority task
+ * @brief A high priority task
*
* @return TC_PASS or TC_FAIL
*/
@@ -455,7 +455,7 @@
/**
*
- * LowPriTask - a low priority task
+ * @brief A low priority task
*
* @return TC_PASS or TC_FAIL
*/
@@ -480,7 +480,7 @@
/**
*
- * AlternateTask - alternate task in the test suite
+ * @brief Alternate task in the test suite
*
* This routine runs at a lower priority than RegressionTask().
*
@@ -559,7 +559,7 @@
/**
*
- * RegressionTask - entry point to semaphore test suite
+ * @brief Entry point to semaphore test suite
*
* This is the entry point to the semaphore test suite.
*
diff --git a/samples/microkernel/test/test_sema/src/test_fiber.c b/samples/microkernel/test/test_sema/src/test_fiber.c
index 5690609..9e1f2e8 100644
--- a/samples/microkernel/test/test_sema/src/test_fiber.c
+++ b/samples/microkernel/test/test_sema/src/test_fiber.c
@@ -57,7 +57,7 @@
/**
*
- * testFiberEntry - the test fiber entry function
+ * @brief The test fiber entry function
*
* Fiber waits on the semaphore controlled by the test task
* It signals the semaphore, the testing task waits for,
@@ -90,7 +90,7 @@
/**
*
- * testFiberInit - initializes variables and starts the test fiber
+ * @brief Initializes variables and starts the test fiber
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_sprintf/src/test_sprintf.c b/samples/microkernel/test/test_sprintf/src/test_sprintf.c
index 01bd2b4..2cbc632 100644
--- a/samples/microkernel/test/test_sprintf/src/test_sprintf.c
+++ b/samples/microkernel/test/test_sprintf/src/test_sprintf.c
@@ -75,7 +75,7 @@
#ifdef CONFIG_FLOAT
/**
*
- * sprintfDoubleTest - test sprintf with doubles
+ * @brief Test sprintf with doubles
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -231,7 +231,7 @@
/**
*
- * tvsnprintf - a test wrapper for vsnprintf()
+ * @brief A test wrapper for vsnprintf()
*/
int tvsnprintf(char *s, size_t len, const char *format, ...)
@@ -248,7 +248,7 @@
/**
*
- * vsnprintfTest - test the vsprintf() routine
+ * @brief Test the vsprintf() routine
*
* This routine does not aim to test the same underlying functionality as
* sprintfTest(). Instead it tries to limit it to functionality specific to
@@ -319,7 +319,7 @@
/**
*
- * tvsprintf - a test wrapper for vsprintf()
+ * @brief A test wrapper for vsprintf()
*/
int tvsprintf(char *s, const char *format, ...)
@@ -336,7 +336,7 @@
/**
*
- * vsprintfTest - test the vsprintf() routine
+ * @brief Test the vsprintf() routine
*
* This routine does not aim to test the same underlying functionality as
* sprintfTest(). Instead it tries to limit it to functionality specific to
@@ -370,7 +370,7 @@
/**
*
- * snprintfTest - test the snprintf() routine
+ * @brief Test the snprintf() routine
*
* This routine does not aim to test the same underlying functionality as
* sprintfTest(). Instead it tries to limit it to functionality specific to
@@ -440,7 +440,7 @@
/**
*
- * sprintfMiscTest - test the sprintf() routine with miscellaneous specifiers
+ * @brief Test the sprintf() routine with miscellaneous specifiers
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -516,7 +516,7 @@
/**
*
- * sprintfIntegerTest - test the sprintf() routine with integers
+ * @brief Test the sprintf() routine with integers
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -669,7 +669,7 @@
/**
*
- * sprintfStringTest - test sprintf with strings
+ * @brief Test sprintf with strings
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -715,7 +715,7 @@
/**
*
- * RegressionTask - test entry point
+ * @brief Test entry point
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_static_idt/src/static_idt.c b/samples/microkernel/test/test_static_idt/src/static_idt.c
index 7c2f6e1..2073797 100644
--- a/samples/microkernel/test/test_static_idt/src/static_idt.c
+++ b/samples/microkernel/test/test_static_idt/src/static_idt.c
@@ -118,7 +118,7 @@
/**
*
- * nanoIdtStubTest - check the IDT.
+ * @brief Check the IDT.
*
* This test examines the IDT and verifies that the static interrupt and
* exception stubs are installed at the correct place.
@@ -174,7 +174,7 @@
/**
*
- * idtSpurTask/Fiber - task/fiber to test spurious handlers
+ * @brief Task/fiber to test spurious handlers
*
* @return 0
*/
@@ -201,7 +201,7 @@
/**
*
- * idtTestTask/main - entry point to static IDT tests
+ * @brief Entry point to static IDT tests
*
* This is the entry point to the static IDT tests.
*
diff --git a/samples/microkernel/test/test_task/src/task.c b/samples/microkernel/test/test_task/src/task.c
index c78cc16..175f8a3 100644
--- a/samples/microkernel/test/test_task/src/task.c
+++ b/samples/microkernel/test/test_task/src/task.c
@@ -72,7 +72,7 @@
/**
*
- * isr_task_command_handler - ISR handler to call isr_task_id_get() and isr_task_priority_get()
+ * @brief ISR handler to call isr_task_id_get() and isr_task_priority_get()
*
* @return N/A
*/
@@ -97,7 +97,7 @@
/**
*
- * isrAPIsTest - test isr_task_id_get() and isr_task_priority_get
+ * @brief Test isr_task_id_get() and isr_task_priority_get
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -125,7 +125,7 @@
/**
*
- * taskMacrosTest - test task_id_get() and task_priority_get() macros
+ * @brief Test task_id_get() and task_priority_get() macros
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -153,7 +153,7 @@
/**
*
- * microObjectsInit - initialize objects used in this microkernel test suite
+ * @brief Initialize objects used in this microkernel test suite
*
* @return N/A
*/
@@ -172,7 +172,7 @@
/**
*
- * helperTaskSetPrioTest - helper task portion to test setting the priority
+ * @brief Helper task portion to test setting the priority
*
* @return N/A
*/
@@ -194,7 +194,7 @@
/**
*
- * taskSetPrioTest - test the task_priority_set() API
+ * @brief Test the task_priority_set() API
*
* @return N/A
*/
@@ -268,7 +268,7 @@
/**
*
- * helperTaskSleepTest - helper task portion to test task_sleep()
+ * @brief Helper task portion to test task_sleep()
*
* @return N/A
*/
@@ -289,7 +289,7 @@
/**
*
- * taskSleepTest - test task_sleep()
+ * @brief Test task_sleep()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -320,7 +320,7 @@
/**
*
- * helperTaskYieldTest - helper task portion of task_yield() test
+ * @brief Helper task portion of task_yield() test
*
* @return N/A
*/
@@ -340,7 +340,7 @@
/**
*
- * taskYieldTest - test task_yield()
+ * @brief Test task_yield()
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -378,7 +378,7 @@
/**
*
- * helperTaskSuspendTest - helper task portion of task_suspend() and
+ * @brief Helper task portion of task_suspend() and
* task_resume() tests
*
* @return N/A
@@ -393,7 +393,7 @@
/**
*
- * taskSuspendTest - test task_suspend() and task_resume()
+ * @brief Test task_suspend() and task_resume()
*
* This test suspends the helper task. Once it is suspended, the main task
* (RegressionTask) sleeps for one second. If the helper task is truly
@@ -432,7 +432,7 @@
/**
*
- * HelperTask - helper task to test the task APIs
+ * @brief Helper task to test the task APIs
*
* @return N/A
*/
@@ -468,7 +468,7 @@
/**
*
- * RegressionTask - main task to test the task APIs
+ * @brief Main task to test the task APIs
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_task_irq/src/main.c b/samples/microkernel/test/test_task_irq/src/main.c
index 0d8c20a..d424f41 100644
--- a/samples/microkernel/test/test_task_irq/src/main.c
+++ b/samples/microkernel/test/test_task_irq/src/main.c
@@ -56,7 +56,7 @@
/**
*
- * taskAMain - entry point for taskA
+ * @brief Entry point for taskA
*
* This routine signals "task done" or "task fail", based on the return code of
* taskA.
@@ -72,7 +72,7 @@
/**
*
- * taskBMain - entry point for taskB
+ * @brief Entry point for taskB
*
* This routine signals "task done" or "task fail", based on the return code of
* taskB.
@@ -88,7 +88,7 @@
/**
*
- * registerWait - wait for devices to be registered and generate SW ints
+ * @brief Wait for devices to be registered and generate SW ints
*
* This routine waits for the tasks to indicate the IRQ objects are allocated and
* then generates SW interrupts for all IRQs. Signals "task done" if all task
@@ -124,7 +124,7 @@
/**
*
- * MonitorTaskEntry - entry point for MonitorTask
+ * @brief Entry point for MonitorTask
*
* This routine keeps tabs on the progress of the tasks doing the actual testing
* and generates the final test case summary message.
diff --git a/samples/microkernel/test/test_task_irq/src/raise_int.c b/samples/microkernel/test/test_task_irq/src/raise_int.c
index 7d5f24f..8906174 100644
--- a/samples/microkernel/test/test_task_irq/src/raise_int.c
+++ b/samples/microkernel/test/test_task_irq/src/raise_int.c
@@ -1390,7 +1390,7 @@
/**
*
- * raiseInt - generate a software interrupt
+ * @brief Generate a software interrupt
*
* This routine will call one of the genInt functions based upon the
* value passed to it (which is essentially the interrupt vector number).
@@ -1409,7 +1409,7 @@
#include <arch/cpu.h>
/**
*
- * raiseInt - generate a software interrupt
+ * @brief Generate a software interrupt
*
* Trigger via NVIC. <id> is the IRQ number.
*
diff --git a/samples/microkernel/test/test_task_irq/src/test_device.c b/samples/microkernel/test/test_task_irq/src/test_device.c
index 20200d9..a52123c 100644
--- a/samples/microkernel/test/test_task_irq/src/test_device.c
+++ b/samples/microkernel/test/test_task_irq/src/test_device.c
@@ -70,7 +70,7 @@
/**
*
- * taskA - first of 2 tasks to allocate IRQ objects and check for events
+ * @brief First of 2 tasks to allocate IRQ objects and check for events
*
* This task allocates 2 IRQ objects with unique IRQs and then tests for an
* interrupt associated with those IRQs. The function then attempts to allocate
@@ -142,7 +142,7 @@
/**
*
- * taskB - second of 2 tasks to allocate IRQ objects and check for events
+ * @brief Second of 2 tasks to allocate IRQ objects and check for events
*
* This task allocates 2 IRQ objects with unique IRQs and then tests for an
* interrupt associated with those IRQs. The function then frees an IRQ object
diff --git a/samples/microkernel/test/test_tickless/src/timestamps.c b/samples/microkernel/test/test_tickless/src/timestamps.c
index 9fa8d84..297d3d9 100644
--- a/samples/microkernel/test/test_tickless/src/timestamps.c
+++ b/samples/microkernel/test/test_tickless/src/timestamps.c
@@ -40,7 +40,7 @@
#if defined(CONFIG_BSP_TI_LM3S6965_QEMU)
/*
- * TI LM3S6965EVM QEMU target - use a General Purpose Timer in
+ * @brief Use a General Purpose Timer in
* 32-bit periodic timer mode (down-counter)
* (RTC mode's resolution of 1 second is insufficient.)
*/
@@ -73,7 +73,7 @@
/**
*
- * _TimestampOpen - timestamp initialization
+ * @brief Timestamp initialization
*
* This routine initializes the timestamp timer.
*
@@ -105,7 +105,7 @@
/**
*
- * _TimestampRead - timestamp timer read
+ * @brief Timestamp timer read
*
* This routine returns the timestamp value.
*
@@ -141,7 +141,7 @@
/**
*
- * _TimestampClose - timestamp release
+ * @brief Timestamp release
*
* This routine releases the timestamp timer.
*
@@ -188,7 +188,7 @@
/**
*
- * _TimestampOpen - timestamp initialization
+ * @brief Timestamp initialization
*
* This routine initializes the timestamp timer.
*
@@ -225,7 +225,7 @@
/**
*
- * _TimestampRead - timestamp timer read
+ * @brief Timestamp timer read
*
* This routine returns the timestamp value.
*
@@ -262,7 +262,7 @@
/**
*
- * _TimestampClose - timestamp release
+ * @brief Timestamp release
*
* This routine releases the timestamp timer.
*
diff --git a/samples/microkernel/test/test_timer/src/timer.c b/samples/microkernel/test/test_timer/src/timer.c
index b41b429..032e57d 100644
--- a/samples/microkernel/test/test_timer/src/timer.c
+++ b/samples/microkernel/test/test_timer/src/timer.c
@@ -54,7 +54,7 @@
/**
*
- * testLowTimerStop - test that task_timer_stop() does stop a timer
+ * @brief Test that task_timer_stop() does stop a timer
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -81,7 +81,7 @@
/**
*
- * testLowTimerPeriodicity - test the periodic feature of a timer
+ * @brief Test the periodic feature of a timer
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -151,7 +151,7 @@
/**
*
- * testLowTimerDoesNotStart - test that the timer does not start
+ * @brief Test that the timer does not start
*
* This test checks that the timer does not start under a variety of
* circumstances.
@@ -190,7 +190,7 @@
/**
*
- * testLowTimerOneShot - test the one shot feature of a timer
+ * @brief Test the one shot feature of a timer
*
* @return TC_PASS on success, TC_FAIL otherwise
*/
@@ -238,7 +238,7 @@
/**
*
- * testLowTimerGet - test the task_timer_alloc() API
+ * @brief Test the task_timer_alloc() API
*
* This routine allocates all the timers in the system using task_timer_alloc().
* It verifies that all the allocated timers have unique IDs before freeing
@@ -319,7 +319,7 @@
/**
*
- * RegressionTaskEntry - regression test's entry point
+ * @brief Regression test's entry point
*
* @return N/A
*/
diff --git a/samples/microkernel/test/test_xip/src/test_xip.c b/samples/microkernel/test/test_xip/src/test_xip.c
index c9ffe12..bd84fa6 100644
--- a/samples/microkernel/test/test_xip/src/test_xip.c
+++ b/samples/microkernel/test/test_xip/src/test_xip.c
@@ -46,7 +46,7 @@
#if defined(CONFIG_NANOKERNEL)
/**
*
- * main - main task entry point
+ * @brief Main task entry point
*
* Entry point for nanokernel only builds.
*
@@ -57,7 +57,7 @@
#else
/**
*
- * RegressionTaskEntry - regression test's entry point
+ * @brief Regression test's entry point
*
* @return N/A
*/
diff --git a/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c b/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c
index 59824d8..bb85e68 100644
--- a/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c
+++ b/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c
@@ -105,7 +105,7 @@
/**
*
- * dummyIsr - dummy ISR
+ * @brief Dummy ISR
*
* @return N/A
*/
@@ -118,7 +118,7 @@
#ifdef TEST_reg
/**
*
- * isrDummyIntStub - static interrupt stub that invokes dummy ISR
+ * @brief Static interrupt stub that invokes dummy ISR
*
* NOTE: This is typically coded in assembly language, rather than C,
* to avoid the preamble code the compiler automatically generates. However,
@@ -139,7 +139,7 @@
/**
*
- * fiberEntry - trivial fiber
+ * @brief Trivial fiber
*
* @param message Message to be printed.
* @param arg1 Unused.
@@ -162,7 +162,7 @@
/**
*
- * main - mainline for background task
+ * @brief Mainline for background task
*
* This routine simply increments a global counter.
* (Gdb can be used to observe the counter as it increases.)
diff --git a/samples/nanokernel/benchmark/sys_kernel/src/lifo.c b/samples/nanokernel/benchmark/sys_kernel/src/lifo.c
index 067a28b..0437cac 100644
--- a/samples/nanokernel/benchmark/sys_kernel/src/lifo.c
+++ b/samples/nanokernel/benchmark/sys_kernel/src/lifo.c
@@ -39,7 +39,7 @@
/**
*
- * lifo_test_init - initialize LIFOs for the test
+ * @brief Initialize LIFOs for the test
*
* @return N/A
*
@@ -55,7 +55,7 @@
/**
*
- * lifo_fiber1 - lifo test context
+ * @brief Lifo test context
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
@@ -95,7 +95,7 @@
/**
*
- * lifo_fiber2 - lifo test context
+ * @brief Lifo test context
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
@@ -127,7 +127,7 @@
/**
*
- * lifo_fiber3 - lifo test context
+ * @brief Lifo test context
*
* @param par1 Address of the counter.
* @param par2 Number of test loops.
@@ -161,7 +161,7 @@
/**
*
- * lifo_test - the main test entry
+ * @brief The main test entry
*
* @return 1 if success and 0 on failure
*
diff --git a/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c b/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c
index db8b765..9e62f3c 100644
--- a/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c
+++ b/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c
@@ -40,7 +40,7 @@
/**
*
- * fifo_test_init - initialize FIFOs for the test
+ * @brief Initialize FIFOs for the test
*
* @return N/A
*
@@ -56,7 +56,7 @@
/**
*
- * fifo_fiber1 - fifo test context
+ * @brief Fifo test context
*
* @return N/A
*
@@ -88,7 +88,7 @@
/**
*
- * fifo_fiber2 - fifo test context
+ * @brief Fifo test context
*
* @return N/A
*
@@ -121,7 +121,7 @@
/**
*
- * fifo_fiber3 - fifo test context
+ * @brief Fifo test context
*
* @return N/A
*
@@ -156,7 +156,7 @@
/**
*
- * fifo_test - the main test entry
+ * @brief The main test entry
*
* @return 1 if success and 0 on failure
*
diff --git a/samples/nanokernel/benchmark/sys_kernel/src/sema.c b/samples/nanokernel/benchmark/sys_kernel/src/sema.c
index 5bdd863..6dbe3f5 100644
--- a/samples/nanokernel/benchmark/sys_kernel/src/sema.c
+++ b/samples/nanokernel/benchmark/sys_kernel/src/sema.c
@@ -37,7 +37,7 @@
/**
*
- * sema_test_init - initialize semaphores for the test
+ * @brief Initialize semaphores for the test
*
* @return N/A
*
@@ -53,7 +53,7 @@
/**
*
- * sema_fiber1 - semaphore test context
+ * @brief Semaphore test context
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
@@ -78,7 +78,7 @@
/**
*
- * sema_fiber2 - semaphore test context
+ * @brief Semaphore test context
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
@@ -102,7 +102,7 @@
/**
*
- * sema_fiber3 - semaphore test context
+ * @brief Semaphore test context
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
@@ -129,7 +129,7 @@
/**
*
- * sema_test - the main test entry
+ * @brief The main test entry
*
* @return 1 if success and 0 on failure
*
diff --git a/samples/nanokernel/benchmark/sys_kernel/src/stack.c b/samples/nanokernel/benchmark/sys_kernel/src/stack.c
index a3c77af..13339c6 100644
--- a/samples/nanokernel/benchmark/sys_kernel/src/stack.c
+++ b/samples/nanokernel/benchmark/sys_kernel/src/stack.c
@@ -40,7 +40,7 @@
/**
*
- * stack_test_init - initialize stacks for the test
+ * @brief Initialize stacks for the test
*
* @return N/A
*
@@ -56,7 +56,7 @@
/**
*
- * stack_fiber1 - stack test context
+ * @brief Stack test context
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
@@ -92,7 +92,7 @@
/**
*
- * stack_fiber2 - stack test context
+ * @brief Stack test context
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
@@ -122,7 +122,7 @@
/**
*
- * stack_fiber2 - stack test context
+ * @brief Stack test context
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
@@ -155,7 +155,7 @@
/**
*
- * stack_test - the main test entry
+ * @brief The main test entry
*
* @return 1 if success and 0 on failure
*
diff --git a/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c b/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c
index 408501d..326fe76 100644
--- a/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c
+++ b/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c
@@ -78,7 +78,7 @@
/**
*
- * begin_test - get the time ticks before test starts
+ * @brief Get the time ticks before test starts
*
* Routine does necessary preparations for the test to start
*
@@ -97,7 +97,7 @@
/**
*
- * check_result - checks number of tests and calculate average time
+ * @brief Checks number of tests and calculate average time
*
* @return 1 if success and 0 on failure
*
@@ -140,7 +140,7 @@
/**
*
- * kbhit - check for a key press
+ * @brief Check for a key press
*
* @return 1 when a keyboard key is pressed, or 0 if no keyboard support
*
@@ -155,7 +155,7 @@
/**
*
- * init_output - prepares the test output
+ * @brief Prepares the test output
*
* @return N/A
*
@@ -177,7 +177,7 @@
/**
*
- * output_close - close output for the test
+ * @brief Close output for the test
*
* @return N/A
*
@@ -190,7 +190,7 @@
/**
*
- * SysKernelBench - perform all selected benchmarks
+ * @brief Perform all selected benchmarks
*
* @return N/A
*
diff --git a/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c b/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c
index 9f53c2b..911c50a 100644
--- a/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c
+++ b/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c
@@ -51,7 +51,7 @@
/**
*
- * isr0 - ISR for IRQ0
+ * @brief ISR for IRQ0
*
* @return N/A
*/
@@ -65,7 +65,7 @@
/**
*
- * isr1 - ISR for IRQ1
+ * @brief ISR for IRQ1
*
* @return N/A
*/
@@ -79,7 +79,7 @@
/**
*
- * isr2 - ISR for IRQ2
+ * @brief ISR for IRQ2
*
* @return N/A
*/
@@ -93,7 +93,7 @@
/**
*
- * main - task entry point
+ * @brief Task entry point
*
* @return N/A
*/
diff --git a/samples/nanokernel/test/test_context/src/context.c b/samples/nanokernel/test/test_context/src/context.c
index c59125a..1625877 100644
--- a/samples/nanokernel/test/test_context/src/context.c
+++ b/samples/nanokernel/test/test_context/src/context.c
@@ -119,7 +119,7 @@
/**
*
- * isr_handler - handler to perform various actions from within an ISR context
+ * @brief Handler to perform various actions from within an ISR context
*
* This routine is the ISR handler for _trigger_isrHandler(). It performs
* the command requested in <isrInfo.command>.
@@ -150,7 +150,7 @@
#if !defined(CONFIG_CPU_CORTEX_M3_M4)
/**
*
- * exc_divide_error_handler - divide by zero exception handler
+ * @brief Divide by zero exception handler
*
* This handler is part of a test that is only interested in detecting the
* error so that we know the exception connect code is working. It simply
@@ -171,7 +171,7 @@
/**
*
- * initNanoObjects - initialize nanokernel objects
+ * @brief Initialize nanokernel objects
*
* This routine initializes the nanokernel objects used in this module's tests.
*
@@ -199,7 +199,7 @@
/**
*
- * nano_cpu_idleTest - test the nano_cpu_idle() routine
+ * @brief Test the nano_cpu_idle() routine
*
* This tests the nano_cpu_idle() routine. The first thing it does is align to
* a tick boundary. The only source of interrupts while the test is running is
@@ -233,7 +233,7 @@
/**
*
- * irq_lockWrapper - a wrapper for irq_lock()
+ * @brief A wrapper for irq_lock()
*
* @return irq_lock() return value
*/
@@ -247,7 +247,7 @@
/**
*
- * irq_unlockWrapper - a wrapper for irq_unlock()
+ * @brief A wrapper for irq_unlock()
*
* @return N/A
*/
@@ -259,7 +259,7 @@
/**
*
- * irq_lock_inlineWrapper - a wrapper for irq_lock_inline()
+ * @brief A wrapper for irq_lock_inline()
*
* @return irq_lock_inline() return value
*/
@@ -273,7 +273,7 @@
/**
*
- * irq_unlock_inlineWrapper - a wrapper for irq_unlock_inline()
+ * @brief A wrapper for irq_unlock_inline()
*
* @return N/A
*/
@@ -285,7 +285,7 @@
/**
*
- * irq_disableWrapper - a wrapper for irq_disable()
+ * @brief A wrapper for irq_disable()
*
* @return <irq>
*/
@@ -298,7 +298,7 @@
/**
*
- * irq_enableWrapper - a wrapper for irq_enable()
+ * @brief A wrapper for irq_enable()
*
* @return N/A
*/
@@ -310,7 +310,7 @@
/**
*
- * nanoCpuDisableInterruptsTest - test routines for disabling and enabling ints
+ * @brief Test routines for disabling and enabling ints
*
* This routine tests the routines for disabling and enabling interrupts. These
* include irq_lock() and irq_unlock(), irq_lock_inline() and
@@ -376,7 +376,7 @@
/**
*
- * nanoCtxTaskTest - test the various nanoCtxXXX() routines from a task
+ * @brief Test the various nanoCtxXXX() routines from a task
*
* This routines tests the context_self_get() and context_type_get() routines from both
* a task and an ISR (that interrupted a task). Checking those routines with
@@ -420,7 +420,7 @@
/**
*
- * nanoCtxFiberTest - test the various nanoCtxXXX() routines from a fiber
+ * @brief Test the various nanoCtxXXX() routines from a fiber
*
* This routines tests the context_self_get() and context_type_get() routines from both
* a fiber and an ISR (that interrupted a fiber). Checking those routines with
@@ -475,7 +475,7 @@
/**
*
- * fiberHelper - entry point to the fiber's helper
+ * @brief Entry point to the fiber's helper
*
* This routine is the entry point to the fiber's helper fiber. It is used to
* help test the behaviour of the fiber_yield() routine.
@@ -512,7 +512,7 @@
/**
*
- * fiber_yieldTest - test the fiber_yield() routine
+ * @brief Test the fiber_yield() routine
*
* This routine tests the fiber_yield() routine. It starts another fiber
* (thus also testing fiber_fiber_start()) and checks that behaviour of
@@ -594,7 +594,7 @@
/**
*
- * fiberEntry - entry point to fiber started by the task
+ * @brief Entry point to fiber started by the task
*
* This routine is the entry point to the fiber started by the task.
*
@@ -817,7 +817,7 @@
/**
*
- * main - entry point to timer tests
+ * @brief Entry point to timer tests
*
* This is the entry point to the CPU and context tests.
*
diff --git a/samples/nanokernel/test/test_fifo/src/fifo.c b/samples/nanokernel/test/test_fifo/src/fifo.c
index 2309af8..b9b1f33 100644
--- a/samples/nanokernel/test/test_fifo/src/fifo.c
+++ b/samples/nanokernel/test/test_fifo/src/fifo.c
@@ -146,7 +146,7 @@
/**
*
- * isr_fifo_put - add an item to a FIFO
+ * @brief Add an item to a FIFO
*
* This routine is the ISR handler for _trigger_nano_isr_fifo_put(). It adds
* an item to the FIFO in the context of an ISR.
@@ -165,7 +165,7 @@
/**
*
- * isr_fifo_get - get an item from a FIFO
+ * @brief Get an item from a FIFO
*
* This routine is the ISR handler for _trigger_nano_isr_fifo_get(). It gets
* an item from the FIFO in the context of an ISR.
@@ -185,7 +185,7 @@
/**
*
- * fiber1 - entry point for the first fiber
+ * @brief Entry point for the first fiber
*
* @return N/A
*/
@@ -254,7 +254,7 @@
/**
*
- * testFiberFifoGetW - test the nano_fiber_fifo_get_wait() interface
+ * @brief Test the nano_fiber_fifo_get_wait() interface
*
* This function tests the fifo put and get wait interfaces in the fiber context.
* It gets data from nanoFifoObj2 queue and puts data to nanoFifoObj queue.
@@ -301,7 +301,7 @@
/**
*
- * testIsrFifoFromFiber - test ISR FIFO routines (triggered from fiber)
+ * @brief Test ISR FIFO routines (triggered from fiber)
*
* This function tests the fifo put and get interfaces in the isr context.
* It is invoked from a fiber.
@@ -355,7 +355,7 @@
/**
*
- * testIsrFifoFromTask - test ISR FIFO routines (triggered from task)
+ * @brief Test ISR FIFO routines (triggered from task)
*
* This function tests the fifo put and get interfaces in the isr context.
* It is invoked from a task.
@@ -418,7 +418,7 @@
/**
*
- * fiber2 - entry point for the second fiber
+ * @brief Entry point for the second fiber
*
* @return N/A
*/
@@ -474,7 +474,7 @@
/**
*
- * fiber3 - entry point for the third fiber
+ * @brief Entry point for the third fiber
*
* @return N/A
*/
@@ -520,7 +520,7 @@
/**
*
- * testTaskFifoGetW - test the nano_task_fifo_get_wait() interface
+ * @brief Test the nano_task_fifo_get_wait() interface
*
* This is in the task context. It puts data to nanoFifoObj2 queue and gets
* data from nanoFifoObj queue.
@@ -560,7 +560,7 @@
/**
*
- * initNanoObjects - initialize nanokernel objects
+ * @brief Initialize nanokernel objects
*
* This routine initializes the nanokernel objects used in the FIFO tests.
*
@@ -590,7 +590,7 @@
/**
*
- * main - entry point to FIFO tests
+ * @brief Entry point to FIFO tests
*
* This is the entry point to the FIFO tests.
*
diff --git a/samples/nanokernel/test/test_lifo/src/lifo.c b/samples/nanokernel/test/test_lifo/src/lifo.c
index 1d872b7..3f55e76 100644
--- a/samples/nanokernel/test/test_lifo/src/lifo.c
+++ b/samples/nanokernel/test/test_lifo/src/lifo.c
@@ -107,7 +107,7 @@
/**
*
- * isr_lifo_put - add an item to a LIFO
+ * @brief Add an item to a LIFO
*
* This routine is the ISR handler for _trigger_nano_isr_lifo_put(). It adds
* an item to the LIFO in the context of an ISR.
@@ -126,7 +126,7 @@
/**
*
- * isr_lifo_get - get an item from a LIFO
+ * @brief Get an item from a LIFO
*
* This routine is the ISR handler for _trigger_nano_isr_lifo_get(). It gets
* an item from the LIFO in the context of an ISR.
@@ -145,7 +145,7 @@
/**
*
- * fiberLifoWaitTest - fiber portion of test that waits on a LIFO
+ * @brief Fiber portion of test that waits on a LIFO
*
* This routine works with taskLifoWaitTest() to test the addition and removal
* of items to/from a LIFO. The cases covered will have a fiber or task waiting
@@ -206,7 +206,7 @@
/**
*
- * fiberLifoNonWaitTest - fiber portion of test that does not wait on a LIFO
+ * @brief Fiber portion of test that does not wait on a LIFO
*
* This routine works with fiberLifoNonWaitTest() to test the addition and
* removal of items from a LIFO without having to wait.
@@ -284,7 +284,7 @@
/**
*
- * fiberEntry - entry point for the fiber portion of the LIFO tests
+ * @brief Entry point for the fiber portion of the LIFO tests
*
* NOTE: The fiber portion of the tests have higher priority than the task
* portion of the tests.
@@ -312,7 +312,7 @@
/**
*
- * taskLifoWaitTest - task portion of test that waits on a LIFO
+ * @brief Task portion of test that waits on a LIFO
*
* This routine works with fiberLifoWaitTest() to test the addition and removal
* of items to/from a LIFO. The cases covered will have a fiber or task waiting
@@ -370,7 +370,7 @@
/**
*
- * taskLifoNonWaitTest - task portion of test that does not wait on a LIFO
+ * @brief Task portion of test that does not wait on a LIFO
*
* This routine works with fiberLifoNonWaitTest() to test the addition and
* removal of items from a LIFO without having to wait.
@@ -448,7 +448,7 @@
/**
*
- * initNanoObjects - initialize nanokernel objects
+ * @brief Initialize nanokernel objects
*
* This routine initializes the nanokernel objects used in the LIFO tests.
*
@@ -494,7 +494,7 @@
/**
*
- * fiber_multi_waiters - fiber entry point for multiple-waiters test
+ * @brief Fiber entry point for multiple-waiters test
*
* @return N/A
*/
@@ -520,7 +520,7 @@
/**
*
- * do_test_multiple_waiters - task part of multiple-waiter test, repeatable
+ * @brief Task part of multiple-waiter test, repeatable
*
* @return N/A
*/
@@ -561,7 +561,7 @@
/**
*
- * test_multiple_waiters - entry point for multiple-waiters test
+ * @brief Entry point for multiple-waiters test
*
* @return N/A
*/
@@ -1051,7 +1051,7 @@
/**
*
- * main - entry point to LIFO tests
+ * @brief Entry point to LIFO tests
*
* This is the entry point to the LIFO tests.
*
diff --git a/samples/nanokernel/test/test_sema/src/sema.c b/samples/nanokernel/test/test_sema/src/sema.c
index 3506e22..3a6ef5c 100644
--- a/samples/nanokernel/test/test_sema/src/sema.c
+++ b/samples/nanokernel/test/test_sema/src/sema.c
@@ -97,7 +97,7 @@
/**
*
- * isr_sem_take - take a semaphore
+ * @brief Take a semaphore
*
* This routine is the ISR handler for _trigger_nano_isr_sem_take(). It takes a
* semaphore within the context of an ISR.
@@ -116,7 +116,7 @@
/**
*
- * isr_sem_give - give a semaphore
+ * @brief Give a semaphore
*
* This routine is the ISR handler for _trigger_nano_isr_sem_take(). It gives a
* semaphore within the context of an ISR.
@@ -136,7 +136,7 @@
/**
*
- * testSemFiberNoWait - give and take the semaphore in a fiber without blocking
+ * @brief Give and take the semaphore in a fiber without blocking
*
* This test gives and takes the test semaphore in the context of a fiber
* without blocking on the semaphore.
@@ -180,7 +180,7 @@
/**
*
- * fiberEntry - entry point for the fiber portion of the semaphore tests
+ * @brief Entry point for the fiber portion of the semaphore tests
*
* NOTE: The fiber portion of the tests have higher priority than the task
* portion of the tests.
@@ -256,7 +256,7 @@
/**
*
- * initNanoObjects - initialize nanokernel objects
+ * @brief Initialize nanokernel objects
*
* This routine initializes the nanokernel objects used in the semaphore tests.
*
@@ -282,7 +282,7 @@
/**
*
- * testSemIsrNoWait - give and take the semaphore in an ISR without blocking
+ * @brief Give and take the semaphore in an ISR without blocking
*
* This test gives and takes the test semaphore in the context of an ISR without
* blocking on the semaphore.
@@ -329,7 +329,7 @@
/**
*
- * testSemTaskNoWait - give and take the semaphore in a task without blocking
+ * @brief Give and take the semaphore in a task without blocking
*
* This test gives and takes the test semaphore in the context of a task without
* blocking on the semaphore.
@@ -372,7 +372,7 @@
/**
*
- * testSemWait - perform tests that wait on a semaphore
+ * @brief Perform tests that wait on a semaphore
*
* This routine works with fiberEntry() to perform the tests that wait on
* a semaphore.
@@ -430,7 +430,7 @@
/**
*
- * fiber_multi_waiters - fiber entry point for multiple-waiters test
+ * @brief Fiber entry point for multiple-waiters test
*
* @return N/A
*/
@@ -446,7 +446,7 @@
/**
*
- * do_test_multiple_waiters - task part of multiple-waiter test, repeatable
+ * @brief Task part of multiple-waiter test, repeatable
*
* @return N/A
*/
@@ -492,7 +492,7 @@
/**
*
- * test_multiple_waiters - entry point for multiple-waiters test
+ * @brief Entry point for multiple-waiters test
*
* @return N/A
*/
@@ -936,7 +936,7 @@
/**
*
- * main - entry point to semaphore tests
+ * @brief Entry point to semaphore tests
*
* This is the entry point to the semaphore tests.
*
diff --git a/samples/nanokernel/test/test_stack/src/stack.c b/samples/nanokernel/test/test_stack/src/stack.c
index 9c0db86..406edf7 100644
--- a/samples/nanokernel/test/test_stack/src/stack.c
+++ b/samples/nanokernel/test/test_stack/src/stack.c
@@ -145,7 +145,7 @@
/**
*
- * isr_stack_push - add an item to a STACK
+ * @brief Add an item to a STACK
*
* This routine is the ISR handler for _trigger_nano_isr_stack_push(). It adds
* an item to the STACK in the context of an ISR.
@@ -165,7 +165,7 @@
/**
*
- * isr_stack_pop - get an item from a STACK
+ * @brief Get an item from a STACK
*
* This routine is the ISR handler for _trigger_nano_isr_stack_pop(). It gets
* an item from the STACK in the context of an ISR. If the queue is empty,
@@ -456,7 +456,7 @@
/**
*
- * fiber3 - a fiber to help test nano_task_stack_pop_wait()
+ * @brief A fiber to help test nano_task_stack_pop_wait()
*
* This fiber blocks for one second before pushing an item onto the stack.
* The main task, which was waiting for item from the stack then unblocks.
@@ -473,7 +473,7 @@
/**
*
- * initNanoObjects - initialize nanokernel objects
+ * @brief Initialize nanokernel objects
*
* This routine initializes the nanokernel objects used in the STACK tests.
*
@@ -497,7 +497,7 @@
/**
*
- * main - entry point to STACK tests
+ * @brief Entry point to STACK tests
*
* This is the entry point to the STACK tests.
*
diff --git a/samples/nanokernel/test/test_timer/src/timer.c b/samples/nanokernel/test/test_timer/src/timer.c
index a62528fd..e158a7a 100644
--- a/samples/nanokernel/test/test_timer/src/timer.c
+++ b/samples/nanokernel/test/test_timer/src/timer.c
@@ -79,7 +79,7 @@
/**
*
- * initNanoObjects - initialize nanokernel objects
+ * @brief Initialize nanokernel objects
*
* This routine initializes the nanokernel objects used in the LIFO tests.
*
@@ -98,7 +98,7 @@
/**
*
- * basicTimerWait - basic checking of time spent waiting upon a timer
+ * @brief Basic checking of time spent waiting upon a timer
*
* This routine can be called from a task or a fiber to wait upon a timer.
* It will busy wait until the current tick ends, at which point it will
@@ -183,7 +183,7 @@
/**
*
- * startTimers - start four timers
+ * @brief Start four timers
*
* This routine starts four timers.
* The first (<timer>) is added to an empty list of timers.
@@ -215,7 +215,7 @@
/**
*
- * busyWaitTimers - busy wait while checking timers expire in the correct order
+ * @brief Busy wait while checking timers expire in the correct order
*
* This routine checks that the four timers created using startTimers() finish
* in the correct order. It busy waits on all four timers waiting until they
@@ -283,7 +283,7 @@
/**
*
- * stopTimers - stop the four timers and make sure they did not expire
+ * @brief Stop the four timers and make sure they did not expire
*
* This routine stops the four started timers and then checks the timers for
* six seconds to make sure that they did not fire. The four timers will be
@@ -327,7 +327,7 @@
/**
*
- * fiber2Entry - entry point for the second fiber
+ * @brief Entry point for the second fiber
*
* The second fiber has a lower priority than the first, but is still given
* precedence over the task.
@@ -348,7 +348,7 @@
/**
*
- * fiberEntry - entry point for the fiber portion of the timer tests
+ * @brief Entry point for the fiber portion of the timer tests
*
* NOTE: The fiber portion of the tests have higher priority than the task
* portion of the tests.
@@ -429,7 +429,7 @@
/**
*
- * nano_cycle_get_32Test - test the nano_cycle_get_32() API
+ * @brief Test the nano_cycle_get_32() API
*
* @return TC_PASS on success, TC_FAIL on failure
*/
@@ -456,7 +456,7 @@
/**
*
- * main - entry point to timer tests
+ * @brief Entry point to timer tests
*
* This is the entry point to the timer tests.
*
diff --git a/scripts/kconfig/list.h b/scripts/kconfig/list.h
index 2cf23f0..0e3dea7 100644
--- a/scripts/kconfig/list.h
+++ b/scripts/kconfig/list.h
@@ -9,7 +9,7 @@
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
/**
- * container_of - cast a member of a structure out to the containing structure
+ * @brief Cast a member of a structure out to the containing structure
* @ptr: the pointer to the member.
* @type: the type of the container struct this is embedded in.
* @member: the name of the member within the struct.
@@ -31,7 +31,7 @@
struct list_head name = LIST_HEAD_INIT(name)
/**
- * list_entry - get the struct for this entry
+ * @brief Get the struct for this entry
* @ptr: the &struct list_head pointer.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_head within the struct.
@@ -51,7 +51,7 @@
pos = list_entry(pos->member.next, typeof(*pos), member))
/**
- * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
+ * @brief Iterate over list of given type safe against removal of list entry
* @pos: the type * to use as a loop cursor.
* @n: another type * to use as temporary storage
* @head: the head for your list.
@@ -64,7 +64,7 @@
pos = n, n = list_entry(n->member.next, typeof(*n), member))
/**
- * list_empty - tests whether a list is empty
+ * @brief Tests whether a list is empty
* @head: the list to test.
*/
static inline int list_empty(const struct list_head *head)
@@ -89,7 +89,7 @@
}
/**
- * list_add_tail - add a new entry
+ * @brief Add a new entry
* @new: new entry to be added
* @head: list head to add it before
*
@@ -117,7 +117,7 @@
#define LIST_POISON1 ((void *) 0x00100100)
#define LIST_POISON2 ((void *) 0x00200200)
/**
- * list_del - deletes entry from list.
+ * @brief Deletes entry from list.
* @entry: the element to delete from the list.
* Note: list_empty() on entry does not return true after this, the entry is
* in an undefined state.
diff --git a/shared/include/nanokernel/x86/idtEnt.h b/shared/include/nanokernel/x86/idtEnt.h
index 0a44977..ca7988f 100644
--- a/shared/include/nanokernel/x86/idtEnt.h
+++ b/shared/include/nanokernel/x86/idtEnt.h
@@ -81,7 +81,7 @@
/**
*
- * _IdtEntCreate - Create an IDT entry
+ * @brief Create an IDT entry
*
* This routine creates an interrupt-gate descriptor at the location defined by
* <pIdtEntry>. The entry is created such that <routine> is invoked when an
