doxygen: \param -> @param

Some comments have \param, convert them to javadoc style.

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

samples/microkernel/apps/hello_world/src/hello.c

@@ -55,9 +55,9 @@
 
 /*
  *
- * \param taskname    task identification string
+ * @param taskname    task identification string
- * \param mySem       task's own semaphore
+ * @param mySem       task's own semaphore
- * \param otherSem    other task's semaphore
+ * @param otherSem    other task's semaphore
  *
  */
 void helloLoop(const char *taskname, ksem_t mySem, ksem_t otherSem)

samples/microkernel/test/test_critical/src/critical.c

@@ -68,7 +68,7 @@ int criticalRtn(void)
  *
  * criticalLoop - common code for invoking task_offload_to_fiber()
  *
- * \param count    number of critical section calls made thus far
+ * @param count    number of critical section calls made thus far
  *
  * RETURNS: number of critical section calls made by task
  */

samples/microkernel/test/test_events/src/events.c

@@ -363,7 +363,7 @@ int fiberEventSignalTest(void)
  *
  * eventHandler - handler to run on EVENT_ID event
  *
- * \param event    signalled event
+ * @param event    signalled event
  *
  * RETURNS: <handlerRetVal>
  */
@@ -381,7 +381,7 @@ int eventHandler(int event)
  *
  * altEventHandler - handler to run on ALT_EVENT event
  *
- * \param event    signalled event
+ * @param event    signalled event
  *
  * RETURNS: 1
  */

samples/microkernel/test/test_fifo/src/fifo.c

@@ -102,8 +102,8 @@ void printMyData(void)
  * This routine verifies current value against expected value
  * and returns true if they are the same.
  *
- * \param expectRetValue     expect value
+ * @param expectRetValue     expect value
- * \param currentRetValue    current value
+ * @param currentRetValue    current value
  *
  * RETURNS:  true, false
  */
@@ -135,8 +135,8 @@ void initMicroObjects(void)
  * This routine fills the FIFO queue with myData array.  This assumes the
  * queue is empty before we put in elements.
  *
- * \param queue          FIFO queue
+ * @param queue          FIFO queue
- * \param numElements    Number of elements used to inserted into the queue
+ * @param numElements    Number of elements used to inserted into the queue
  *
  * RETURNS: TC_PASS, TC_FAIL
  *
@@ -279,7 +279,7 @@ exitTest4:
  * that they are in the right order. Expect the dequeue order as: myData[0],
  * myData[1].
  *
- * \param loopCnt    number of elements passed to the for loop
+ * @param loopCnt    number of elements passed to the for loop
  *
  * RETURNS:  TC_PASS, TC_FAIL
  *

samples/microkernel/test/test_map/src/map.c

@@ -67,8 +67,8 @@ int testMapFreeAllBlocks(void **P);
  * This routine verifies current value against expected value
  * and returns true if they are the same.
  *
- * \param expectRetValue     expect value
+ * @param expectRetValue     expect value
- * \param currentRetValue    current value
+ * @param currentRetValue    current value
  *
  * RETURNS:  true, false
  */
@@ -152,7 +152,7 @@ exitTest1:
  *
  *   task_mem_map_alloc(), task_mem_map_used_get()
  *
- * \param p    pointer to pointer of allocated blocks
+ * @param p    pointer to pointer of allocated blocks
  *
  * RETURNS:  TC_PASS, TC_FAIL
  */
@@ -224,7 +224,7 @@ int testMapGetAllBlocks(void **p)
  *
  *   task_mem_map_free(), task_mem_map_used_get()
  *
- * \param p    pointer to pointer of allocated blocks
+ * @param p    pointer to pointer of allocated blocks
  *
  * RETURNS:  TC_PASS, TC_FAIL
  */
@@ -279,7 +279,7 @@ int testMapFreeAllBlocks(void **p)
  *
  * This routine prints out the pointers.
  *
- * \param pointer    pointer to pointer of allocated blocks
+ * @param pointer    pointer to pointer of allocated blocks
  *
  * RETURNS:  N/A
  */

samples/microkernel/test/test_pipe/src/pipe.c

@@ -176,8 +176,8 @@ void microObjectsInit(void)
  *
  * receiveBufferCheck - check the contents of the receive buffer
  *
- * \param buffer    pointer to buffer to check
+ * @param buffer    pointer to buffer to check
- * \param size      number of bytes to check
+ * @param size      number of bytes to check
  *
  * RETURNS: <size> on success, index of wrong character on failure
  */
@@ -199,10 +199,10 @@ int receiveBufferCheck(char *buffer, int size)
  *
  * pipePutHelperWork - helper routine to pipePutTest()
  *
- * \param singleItems    testcase list (one item in the pipe)
+ * @param singleItems    testcase list (one item in the pipe)
- * \param nSingles       number of items in testcase
+ * @param nSingles       number of items in testcase
- * \param manyItems      testcase list (many items in the pipe)
+ * @param manyItems      testcase list (many items in the pipe)
- * \param nMany          number of items in testcase
+ * @param nMany          number of items in testcase
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */
@@ -336,10 +336,10 @@ int pipePutHelper(void)
  *
  * This routine tests the task_pipe_put() API.
  *
- * \param singleItems    testcase list (one item in the pipe)
+ * @param singleItems    testcase list (one item in the pipe)
- * \param nSingles       number of items in testcase
+ * @param nSingles       number of items in testcase
- * \param manyItems      testcase list (many items in the pipe)
+ * @param manyItems      testcase list (many items in the pipe)
- * \param nMany          number of items in testcase
+ * @param nMany          number of items in testcase
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */
@@ -777,8 +777,8 @@ int pipeGetTest(void)
  *
  * pipeGetWaitHelperWork - test task_pipe_get_wait()
  *
- * \param items     testcase list for task_pipe_get_wait()
+ * @param items     testcase list for task_pipe_get_wait()
- * \param nItems    number of items in list
+ * @param nItems    number of items in list
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */
@@ -842,8 +842,8 @@ int pipeGetWaitHelper(void)
  *
  * pipeGetWaitTestWork - test task_pipe_get_wait()
  *
- * \param items     testcase list for task_pipe_get_wait()
+ * @param items     testcase list for task_pipe_get_wait()
- * \param nItems    number of items in list
+ * @param nItems    number of items in list
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */

samples/microkernel/test/test_sema/src/main.c

@@ -163,7 +163,7 @@ void LowPriTaskEntry(void)
  *
  * testIsrHandler - ISR that gives specified semaphore
  *
- * \param isrData    pointer to semaphore to be given
+ * @param isrData    pointer to semaphore to be given
  *
  * RETURNS: N/A
  */
@@ -177,7 +177,7 @@ static void testIsrHandler(void *isrData)
  *
  * trigger_isrSemaSignal - generate interrupt that gives specified semaphore
  *
- * \param semaphore    semaphore to be given
+ * @param semaphore    semaphore to be given
  *
  * RETURNS: N/A
  */

samples/microkernel/test/test_stackprot/src/stackprot.c

@@ -71,7 +71,7 @@ void check_input(const char *name, const char *input);
  * This function calls check_input 6 times with the input name and a short
  * string, which is printed properly by check_input.
  *
- * \param name    task or fiber identification string
+ * @param name    task or fiber identification string
  *
  * RETURNS: N/A
  */

samples/nanokernel/test/test_context/src/context.c

@@ -480,8 +480,8 @@ int nanoCtxFiberTest(nano_context_id_t taskCtxId)
  * 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.
  *
- * \param arg1    unused
+ * @param arg1    unused
- * \param arg2    unused
+ * @param arg2    unused
  *
  * RETURNS: N/A
  */
@@ -598,8 +598,8 @@ int fiber_yieldTest(void)
  *
  * This routine is the entry point to the fiber started by the task.
  *
- * \param taskCtxId    context ID of the spawning task
+ * @param taskCtxId    context ID of the spawning task
- * \param arg1         unused
+ * @param arg1         unused
  *
  * RETURNS: N/A
  */

samples/nanokernel/test/test_fifo/src/fifo.c

@@ -151,7 +151,7 @@ extern int test_fifo_timeout(void);
  * 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.
  *
- * \param parameter    pointer to ISR handler parameter
+ * @param parameter    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */
@@ -170,7 +170,7 @@ void isr_fifo_put(void *parameter)
  * 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.
  *
- * \param parameter    pointer to ISR handler parameter
+ * @param parameter    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */

samples/nanokernel/test/test_lifo/src/lifo.c

@@ -112,7 +112,7 @@ static struct nano_sem reply_multi_waiters;
  * 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.
  *
- * \param data    pointer to ISR handler parameter
+ * @param data    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */
@@ -131,7 +131,7 @@ void isr_lifo_put(void *data)
  * 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.
  *
- * \param data    pointer to ISR handler parameter
+ * @param data    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */
@@ -289,8 +289,8 @@ errorReturn:
  * NOTE: The fiber portion of the tests have higher priority than the task
  * portion of the tests.
  *
- * \param arg1    unused
+ * @param arg1    unused
- * \param arg2    unused
+ * @param arg2    unused
  *
  * RETURNS: N/A
  */

samples/nanokernel/test/test_sema/src/sema.c

@@ -102,7 +102,7 @@ static struct nano_sem reply_multi_waiters;
  * This routine is the ISR handler for _trigger_nano_isr_sem_take().  It takes a
  * semaphore within the context of an ISR.
  *
- * \param data    pointer to ISR handler parameter
+ * @param data    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */
@@ -121,7 +121,7 @@ void isr_sem_take(void *data)
  * This routine is the ISR handler for _trigger_nano_isr_sem_take().  It gives a
  * semaphore within the context of an ISR.
  *
- * \param data    pointer to ISR handler parameter
+ * @param data    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */
@@ -185,8 +185,8 @@ errorReturn:
  * NOTE: The fiber portion of the tests have higher priority than the task
  * portion of the tests.
  *
- * \param arg1    unused
+ * @param arg1    unused
- * \param arg2    unused
+ * @param arg2    unused
  *
  * RETURNS: N/A
  */

samples/nanokernel/test/test_stack/src/stack.c

@@ -150,7 +150,7 @@ void initData(void)
  * 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.
  *
- * \param parameter    pointer to ISR handler parameter
+ * @param parameter    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */
@@ -171,7 +171,7 @@ void isr_stack_push(void *parameter)
  * an item from the STACK in the context of an ISR.  If the queue is empty,
  * it sets data to INVALID_DATA.
  *
- * \param parameter    pointer to ISR handler parameter
+ * @param parameter    pointer to ISR handler parameter
  *
  * RETURNS: N/A
  */

samples/nanokernel/test/test_timer/src/timer.c

@@ -110,12 +110,12 @@ void initNanoObjects(void)
  * This routine can be considered as testing nano_tick_get_32(),
  * nanoTimeElapsed() and nanoXXXTimerGetW() successful expiration cases.
  *
- * \param startRtn      routine to start the timer
+ * @param startRtn      routine to start the timer
- * \param waitRtn       routine to get and wait for the timer
+ * @param waitRtn       routine to get and wait for the timer
- * \param getRtn        routine to get the timer (no waiting)
+ * @param getRtn        routine to get the timer (no waiting)
- * \param pTimer        pointer to the timer
+ * @param pTimer        pointer to the timer
- * \param pTimerData    pointer to the expected timer data
+ * @param pTimerData    pointer to the expected timer data
- * \param ticks         number of ticks to wait
+ * @param ticks         number of ticks to wait
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */
@@ -193,7 +193,7 @@ int basicTimerWait(timer_start_func startRtn, timer_getw_func waitRtn,
  *
  * Four timers are used so that the various paths can be tested.
  *
- * \param startRtn    routine to start the timers
+ * @param startRtn    routine to start the timers
  *
  * RETURNS: N/A
  */
@@ -222,7 +222,7 @@ void startTimers(timer_start_func startRtn)
  * expire.  The timers are expected to expire in the following order:
  *     <shortTimer>, <timer>, <midTimer>, <longTimer>
  *
- * \param getRtn    timer get routine (fiber or task)
+ * @param getRtn    timer get routine (fiber or task)
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */
@@ -291,8 +291,8 @@ int busyWaitTimers(timer_get_func getRtn)
  * exercise the code that removes timers from important locations in the list;
  * these include the middle, the head, the tail, and the last item.
  *
- * \param stopRtn    routine to stop timer (fiber or task)
+ * @param stopRtn    routine to stop timer (fiber or task)
- * \param getRtn     timer get routine (fiber or task)
+ * @param getRtn     timer get routine (fiber or task)
  *
  * RETURNS: TC_PASS on success, TC_FAIL on failure
  */
@@ -332,8 +332,8 @@ int stopTimers(timer_stop_func stopRtn, timer_get_func getRtn)
  * The second fiber has a lower priority than the first, but is still given
  * precedence over the task.
  *
- * \param arg1    unused
+ * @param arg1    unused
- * \param arg2    unused
+ * @param arg2    unused
  *
  * RETURNS: N/A
  */
@@ -353,8 +353,8 @@ static void fiber2Entry(int arg1, int arg2)
  * NOTE: The fiber portion of the tests have higher priority than the task
  * portion of the tests.
  *
- * \param arg1    unused
+ * @param arg1    unused
- * \param arg2    unused
+ * @param arg2    unused
  *
  * RETURNS: N/A
  */

samples/network/listener/src/listener.c

@@ -92,9 +92,9 @@ static struct net_context *get_context(const struct net_addr *addr)
 
 /*
  *
- * \param taskname    task identification string
+ * @param taskname    task identification string
- * \param mySem       task's own semaphore
+ * @param mySem       task's own semaphore
- * \param otherSem    other task's semaphore
+ * @param otherSem    other task's semaphore
  *
  */
 void helloLoop(const char *taskname, ksem_t mySem, ksem_t otherSem)

samples/network/test_15_4/src/network.c

@@ -169,9 +169,9 @@ static struct net_context *get_context(const struct net_addr *remote,
 
 /*
  *
- * \param taskname    task identification string
+ * @param taskname    task identification string
- * \param mySem       task's own semaphore
+ * @param mySem       task's own semaphore
- * \param otherSem    other task's semaphore
+ * @param otherSem    other task's semaphore
  *
  */
 static void listen(const char *taskname, ksem_t mySem, ksem_t otherSem,