doxygen: RETURNS: -> @return

Previous comment style used RETRURNS:, use @return to comply
with javadoc style.

Change-Id: Ib1dffd92da1d97d60063ec5309b08049828f6661
Signed-off-by: Anas Nashif <anas.nashif@intel.com>

arch/arm/core/atomic.S

@@ -68,7 +68,7 @@ GTEXT(atomic_cas)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -91,7 +91,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_clear)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -144,7 +144,7 @@ SECTION_FUNC(TEXT, atomic_get)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -170,7 +170,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_inc)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -204,7 +204,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_add)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -230,7 +230,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_decSub, atomic_dec)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -264,7 +264,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_decSub, atomic_sub)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -299,7 +299,7 @@ SECTION_FUNC(TEXT, atomic_nand)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -333,7 +333,7 @@ SECTION_FUNC(TEXT, atomic_and)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -367,7 +367,7 @@ SECTION_FUNC(TEXT, atomic_or)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: Contents of <target> before the atomic operation
+ * @return Contents of <target> before the atomic operation
  *
  * ERRNO: N/A
  *
@@ -401,7 +401,7 @@ SECTION_FUNC(TEXT, atomic_xor)
  *
  * This routine can be used from both task and interrupt level.
  *
- * RETURNS: 1 if the swap is actually executed, 0 otherwise.
+ * @return 1 if the swap is actually executed, 0 otherwise.
  *
  * ERRNO: N/A
  *

arch/arm/core/basepri.S

@@ -69,7 +69,7 @@ GTEXT(irq_unlock)
  * This function can be called recursively: it will return a key to return the
  * state of interrupt locking to the previous level.
  *
- * RETURNS: a key to return to the previous interrupt locking level
+ * @return a key to return to the previous interrupt locking level
  */
 
 SECTION_FUNC(TEXT,irq_lock)
@@ -85,7 +85,7 @@ SECTION_FUNC(TEXT,irq_lock)
  * Return the state of interrupt locking to a previous level, passed in via the
  * <key> parameter, obtained from a previous call to irq_lock().
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_FUNC(TEXT,irq_unlock)

arch/arm/core/context.c

@@ -59,7 +59,7 @@ tNANO _nanokernel = {0};
  *
  * Currently only inserts the new context in the list of active contexts.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 static ALWAYS_INLINE void _context_monitor_init(struct ccs *pCcs /* context */
@@ -99,7 +99,7 @@ static ALWAYS_INLINE void _context_monitor_init(struct ccs *pCcs /* context */
  *
  * <options> is currently unused.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void _NewContext(

arch/arm/core/cpu_idle.S

@@ -63,7 +63,7 @@ GTEXT(nano_cpu_atomic_idle)
  * Only called by nanoArchInit(). Sets SEVONPEND bit once for the system's
  * duration.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * C function prototype:
  *
@@ -84,7 +84,7 @@ SECTION_FUNC(TEXT, _CpuIdleInit)
  *
  * Returns the nanokernel idle setting, in ticks. Only called by __systick().
  *
- * RETURNS: the requested number of ticks for the kernel to be idle
+ * @return the requested number of ticks for the kernel to be idle
  *
  * C function prototype:
  *
@@ -102,7 +102,7 @@ SECTION_FUNC(TEXT, _NanoIdleValGet)
  *
  * Sets the nanokernel idle setting to 0. Only called by __systick().
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * C function prototype:
  *
@@ -126,7 +126,7 @@ SECTION_FUNC(TEXT, _NanoIdleValClear)
  * '_sys_power_save_flag' variable is non-zero.  The ARM 'wfi' instruction
  * will be issued, causing a low-power consumption sleep mode.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * C function prototype:
  *
@@ -161,7 +161,7 @@ SECTION_FUNC(TEXT, nano_cpu_idle)
  * 2) After waking up from the low-power mode, the interrupt lockout state
  *    must be restored as indicated in the 'imask' input parameter.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * C function prototype:
  *

arch/arm/core/exc_exit.S

@@ -84,7 +84,7 @@ GDATA(_nanokernel)
  *     _IntExit();
  *     }
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _IntExit)
@@ -99,7 +99,7 @@ SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _IntExit)
  *
  * See _IntExit().
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _ExcExit)

arch/arm/core/fatal.c

@@ -75,7 +75,7 @@ const NANO_ESF _default_esf = {0xdeaddead, /* a1 */
  * fatal error does not have a hardware generated ESF, the caller should either
  * create its own or use a pointer to the global default ESF <_default_esf>.
  *
- * RETURNS: This function does not return.
+ * @return This function does not return.
  *
  * \NOMANUAL
  */

arch/arm/core/fault.c

@@ -73,7 +73,7 @@ Common fault handler for ARM Cortex-M processors.
  * MMFSR: 0x00000000, BFSR: 0x00000082, UFSR: 0x00000000
  * BFAR: 0xff001234
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -124,7 +124,7 @@ void _FaultDump(const NANO_ESF *esf, int fault)
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -143,7 +143,7 @@ static void _FaultContextShow(const NANO_ESF *esf)
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -178,7 +178,7 @@ static void _MpuFault(const NANO_ESF *esf,
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -219,7 +219,7 @@ static void _BusFault(const NANO_ESF *esf,
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -259,7 +259,7 @@ static void _UsageFault(const NANO_ESF *esf)
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -287,7 +287,7 @@ static void _HardFault(const NANO_ESF *esf)
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -303,7 +303,7 @@ static void _DebugMonitor(const NANO_ESF *esf)
  *
  * See _FaultDump() for example.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -333,7 +333,7 @@ static void _ReservedException(const NANO_ESF *esf,
  *   Precise data bus error
  *   Address: 0xff001234
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */
@@ -376,7 +376,7 @@ static void _FaultDump(const NANO_ESF *esf, int fault)
  * interrupt was already being handled, it is passed a pointer to both and has
  * to find out on which the ESP is present.
  *
- * RETURNS: This function does not return.
+ * @return This function does not return.
  *
  * \NOMANUAL
  */
@@ -400,7 +400,7 @@ void _Fault(
  *
  * Turns on the desired hardware faults.
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */

arch/arm/core/ffs.S

@@ -57,7 +57,7 @@ GTEXT(find_first_set)
  * at 1 from the least significant bit.  A return value of zero indicates that
  * the value passed is zero.
  *
- * RETURNS: most significant bit set
+ * @return most significant bit set
  */
 
 SECTION_FUNC(TEXT, find_last_set)
@@ -78,7 +78,7 @@ SECTION_FUNC(TEXT, find_last_set)
  * at 1 from the least significant bit.  A return value of zero indicates that
  * the value passed is zero.
  *
- * RETURNS: least significant bit set
+ * @return least significant bit set
  */
 
 SECTION_FUNC(TEXT, find_first_set)

arch/arm/core/fiber_abort.c

@@ -61,7 +61,7 @@ the PendSV exception.
  * - the fiber implicitly aborts by returning from its entry point
  * - the fiber encounters a fatal exception
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void fiber_abort(void)

arch/arm/core/gdb_stub.S

@@ -70,7 +70,7 @@ _ASM_FILE_PROLOGUE
  * - must be called with interrupts locked
  * - cannot use r0 without saving it first
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_FUNC(TEXT, _GdbStubExcEntry)
@@ -107,7 +107,7 @@ SECTION_FUNC(TEXT, _GdbStubExcEntry)
  * - must be called with interrupts locked
  * - cannot use r0 without saving it first
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_FUNC(TEXT, _GdbStubExcExit)
@@ -145,7 +145,7 @@ SECTION_FUNC(TEXT, _GdbStubExcExit)
  * This stub must also act as a demuxer that find the running exception and
  * invoke the user's real ISR.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_FUNC(TEXT, _irq_vector_table_entry_with_gdb_stub)

arch/arm/core/irq_init.c

@@ -53,7 +53,7 @@ the PendSV exception.
  * not 0, which they have it set to when coming out of reset. This ensures that
  * interrupt locking via BASEPRI works as expected.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void _IntLibInit(void)

arch/arm/core/irq_manage.c

@@ -56,7 +56,7 @@ extern void __reserved(void);
  * This routine will hang if <old> is not found in the table and ASSERT_ON is
  * enabled.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void irq_handler_set(unsigned int irq,
@@ -84,7 +84,7 @@ void irq_handler_set(unsigned int irq,
  * line. After this call, the CPU will receive interrupts for the specified
  * <irq>.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void irq_enable(unsigned int irq)
@@ -101,7 +101,7 @@ void irq_enable(unsigned int irq)
  * Disable an interrupt line. After this call, the CPU will stop receiving
  * interrupts for the specified <irq>.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void irq_disable(unsigned int irq)
@@ -121,7 +121,7 @@ void irq_disable(unsigned int irq)
  *
  * The priority is verified if ASSERT_ON is enabled.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void irq_priority_set(unsigned int irq,
@@ -140,7 +140,7 @@ void irq_priority_set(unsigned int irq,
  *
  * See __reserved().
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void _irq_spurious(void *unused)
@@ -159,7 +159,7 @@ void _irq_spurious(void *unused)
  * This routine will hang if another ISR was connected for interrupt line <irq>
  * and ASSERT_ON is enabled; if ASSERT_ON is disabled, it will fail silently.
  *
- * RETURNS: the interrupt line number
+ * @return the interrupt line number
  */
 
 int irq_connect(unsigned int irq,
@@ -180,7 +180,7 @@ int irq_connect(unsigned int irq,
  * the latter is replaced by _irq_spurious(). irq_disable() should have
  * been called before invoking this routine.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 void irq_disconnect(unsigned int irq)

arch/arm/core/isr_wrapper.S

@@ -64,7 +64,7 @@ GTEXT(_IntExit)
  * pends the PendSV exception if so: the latter will perform the context switch
  * itself.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 SECTION_FUNC(TEXT, _isr_wrapper)
 

arch/arm/core/swap.S

@@ -153,7 +153,7 @@ SECTION_FUNC(TEXT, __pendsv)
  * 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.
  *
- * RETURNS: N/A
+ * @return N/A
  */
 
 SECTION_FUNC(TEXT, __svc)
@@ -203,7 +203,7 @@ SECTION_FUNC(TEXT, __svc)
  * outgoing context. This is all performed by the hardware, which stores it in
  * its exception stack frame, created when handling the svc exception.
  *
- * RETURNS: may contain a return value setup by a call to fiberRtnValueSet()
+ * @return may contain a return value setup by a call to fiberRtnValueSet()
  *
  * C function prototype:
  *

arch/arm/core/task_abort.c

@@ -62,7 +62,7 @@ static struct k_args cmd_packet;
  * - the task implicitly aborts by returning from its entry point
  * - the task encounters a fatal exception
  *
- * RETURNS: N/A
+ * @return N/A
  *
  * \NOMANUAL
  */