tests: fix doxygen comments

Fix many warnings resulting from doxygen comments in tests.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2018-05-06 22:37:10 -05:00 committed by Anas Nashif
parent 540e11ced7
commit c57326e1b6
13 changed files with 44 additions and 10 deletions

View File

@ -8,6 +8,10 @@
#include <stdbool.h>
#include <ztest.h>
/**
* @cond INTERNAL_HIDDEN
*/
/* The file.inc contains characters from 0 to 255 */
static const unsigned char inc_file[] = {
#include <file.bin.inc>
@ -17,6 +21,10 @@ static const unsigned char gz_inc_file[] = {
#include <file.bin.gz.inc>
};
/**
* @endcond
*/
static const unsigned char compressed_inc_file[] = {
0x1f, 0x8b, 0x08, 0x00, 0xb0, 0xd6, 0xb8, 0x59,
0x02, 0xff, 0x01, 0x00, 0x01, 0xff, 0xfe, 0x00,

View File

@ -5,7 +5,9 @@
*/
/**
* @file measure context switch time between cooperative threads
* @file
*
* @brief Measure context switch time between cooperative threads
*
* This file contains thread (coop) context switch time measurement.
* The thread starts two cooperative thread. One thread waits on a semaphore. The other,

View File

@ -6,7 +6,9 @@
*/
/**
* @file measure time from ISR back to interrupted thread
* @file
*
* @brief Measure time from ISR back to interrupted thread
*
* This file contains test that measures time to switch from the interrupt
* handler back to the interrupted thread.

View File

@ -5,7 +5,9 @@
*/
/**
* @file measure time from ISR to a rescheduled thread
* @file
*
* @brief measure time from ISR to a rescheduled thread
*
* This file contains test that measures time to switch from an interrupt
* handler to executing a thread after rescheduling. In other words, execution

View File

@ -32,6 +32,7 @@ void lifo_test_init(void)
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
* @param par3 unused
*
* @return N/A
*/
@ -72,6 +73,7 @@ void lifo_thread1(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 unused
*
* @return N/A
*/
@ -103,6 +105,7 @@ void lifo_thread2(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test loops.
* @param par3 unused
*
* @return N/A
*/

View File

@ -34,6 +34,7 @@ void fifo_test_init(void)
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
* @param par3 unused
*
* @return N/A
*/
@ -66,6 +67,7 @@ void fifo_thread1(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 unused
*
* @return N/A
*/
@ -100,6 +102,7 @@ void fifo_thread2(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 unused
*
* @return N/A
*/

View File

@ -30,6 +30,7 @@ void sema_test_init(void)
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
* @param par3 Unused
*
* @return N/A
*/
@ -54,6 +55,7 @@ void sema_thread1(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*/
@ -78,6 +80,7 @@ void sema_thread2(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*/

View File

@ -34,6 +34,7 @@ void stack_test_init(void)
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
* @param par3 Unused
*
* @return N/A
*
@ -70,6 +71,7 @@ void stack_thread1(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*
@ -101,6 +103,7 @@ void stack_thread2(void *par1, void *par2, void *par3)
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*

View File

@ -5,7 +5,9 @@
*/
/**
* @file Sample app to illustrate dma transfer on Intel_S1000.
* @file
*
* @brief Sample app to illustrate dma transfer on Intel_S1000.
*
* Intel_S1000 - Xtensa
* --------------------
@ -19,9 +21,9 @@
* - Set direction memory-to-memory
* - Start transfer
*
* - Expected Results
* Expected Results
* - Data is transferred correctly from src to dest. The DMAed string should
* be printed on to the console. No error should be seen.
* be printed on to the console. No error should be seen.
*/
#include <zephyr.h>

View File

@ -5,7 +5,9 @@
*/
/**
* @file Sample app to utilize GPIO on Intel_S1000.
* @file
*
* @brief Sample app to utilize GPIO on Intel_S1000.
*
* Intel_S1000 - Xtensa
* --------------------

View File

@ -5,7 +5,9 @@
*/
/**
* @file Sample app to illustrate i2c master-slave communication on Intel_S1000.
* @file
*
* @brief Sample app to illustrate i2c master-slave communication on Intel_S1000.
*
* Intel_S1000 - Xtensa
* --------------------

View File

@ -5,7 +5,9 @@
*/
/**
* @file Sample app to illustrate I2S transmission (playback) on Intel_S1000.
* @file
*
* @brief Sample app to illustrate I2S transmission (playback) on Intel_S1000.
*
* Intel_S1000 - Xtensa
* --------------------

View File

@ -27,7 +27,7 @@
#endif
/**
* @def TC_PRINT_RUN_ID
* @def TC_PRINT_RUNID
* @brief Report a Run ID
*
* When the CPP symbol \c TC_RUNID is defined (for example, from the