From c57326e1b69a7bbefdc4fb6703baae0d61658faa Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Sun, 6 May 2018 22:37:10 -0500 Subject: [PATCH] tests: fix doxygen comments Fix many warnings resulting from doxygen comments in tests. Signed-off-by: Anas Nashif --- tests/application_development/gen_inc_file/src/main.c | 8 ++++++++ tests/benchmarks/latency_measure/src/coop_ctx_switch.c | 4 +++- tests/benchmarks/latency_measure/src/int_to_thread.c | 4 +++- tests/benchmarks/latency_measure/src/int_to_thread_evt.c | 4 +++- tests/benchmarks/sys_kernel/src/lifo.c | 3 +++ tests/benchmarks/sys_kernel/src/mwfifo.c | 3 +++ tests/benchmarks/sys_kernel/src/sema.c | 3 +++ tests/benchmarks/sys_kernel/src/stack.c | 3 +++ tests/boards/intel_s1000_crb/src/dma_test.c | 8 +++++--- tests/boards/intel_s1000_crb/src/gpio_test.c | 4 +++- tests/boards/intel_s1000_crb/src/i2c_test.c | 4 +++- tests/boards/intel_s1000_crb/src/i2s_test.c | 4 +++- tests/include/tc_util.h | 2 +- 13 files changed, 44 insertions(+), 10 deletions(-) diff --git a/tests/application_development/gen_inc_file/src/main.c b/tests/application_development/gen_inc_file/src/main.c index ad059594e4a..439bfcd624a 100644 --- a/tests/application_development/gen_inc_file/src/main.c +++ b/tests/application_development/gen_inc_file/src/main.c @@ -8,6 +8,10 @@ #include #include +/** + * @cond INTERNAL_HIDDEN + */ + /* The file.inc contains characters from 0 to 255 */ static const unsigned char inc_file[] = { #include @@ -17,6 +21,10 @@ static const unsigned char gz_inc_file[] = { #include }; +/** + * @endcond + */ + static const unsigned char compressed_inc_file[] = { 0x1f, 0x8b, 0x08, 0x00, 0xb0, 0xd6, 0xb8, 0x59, 0x02, 0xff, 0x01, 0x00, 0x01, 0xff, 0xfe, 0x00, diff --git a/tests/benchmarks/latency_measure/src/coop_ctx_switch.c b/tests/benchmarks/latency_measure/src/coop_ctx_switch.c index 22853a93fe5..1605d355ccc 100644 --- a/tests/benchmarks/latency_measure/src/coop_ctx_switch.c +++ b/tests/benchmarks/latency_measure/src/coop_ctx_switch.c @@ -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, diff --git a/tests/benchmarks/latency_measure/src/int_to_thread.c b/tests/benchmarks/latency_measure/src/int_to_thread.c index da4e71d870c..bad34a0bb86 100644 --- a/tests/benchmarks/latency_measure/src/int_to_thread.c +++ b/tests/benchmarks/latency_measure/src/int_to_thread.c @@ -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. diff --git a/tests/benchmarks/latency_measure/src/int_to_thread_evt.c b/tests/benchmarks/latency_measure/src/int_to_thread_evt.c index 91119d9998b..791751e6b14 100644 --- a/tests/benchmarks/latency_measure/src/int_to_thread_evt.c +++ b/tests/benchmarks/latency_measure/src/int_to_thread_evt.c @@ -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 diff --git a/tests/benchmarks/sys_kernel/src/lifo.c b/tests/benchmarks/sys_kernel/src/lifo.c index 7b96c87c23a..bad6924ec12 100644 --- a/tests/benchmarks/sys_kernel/src/lifo.c +++ b/tests/benchmarks/sys_kernel/src/lifo.c @@ -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 */ diff --git a/tests/benchmarks/sys_kernel/src/mwfifo.c b/tests/benchmarks/sys_kernel/src/mwfifo.c index c33945664fe..f0b8960e9b5 100644 --- a/tests/benchmarks/sys_kernel/src/mwfifo.c +++ b/tests/benchmarks/sys_kernel/src/mwfifo.c @@ -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 */ diff --git a/tests/benchmarks/sys_kernel/src/sema.c b/tests/benchmarks/sys_kernel/src/sema.c index 458f810643a..0000b3266b6 100644 --- a/tests/benchmarks/sys_kernel/src/sema.c +++ b/tests/benchmarks/sys_kernel/src/sema.c @@ -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 */ diff --git a/tests/benchmarks/sys_kernel/src/stack.c b/tests/benchmarks/sys_kernel/src/stack.c index 0bb1f93554a..c2a5af3da0e 100644 --- a/tests/benchmarks/sys_kernel/src/stack.c +++ b/tests/benchmarks/sys_kernel/src/stack.c @@ -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 * diff --git a/tests/boards/intel_s1000_crb/src/dma_test.c b/tests/boards/intel_s1000_crb/src/dma_test.c index eb1a87f8512..40657da445c 100644 --- a/tests/boards/intel_s1000_crb/src/dma_test.c +++ b/tests/boards/intel_s1000_crb/src/dma_test.c @@ -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 diff --git a/tests/boards/intel_s1000_crb/src/gpio_test.c b/tests/boards/intel_s1000_crb/src/gpio_test.c index f4b5af83968..730ddfc7403 100644 --- a/tests/boards/intel_s1000_crb/src/gpio_test.c +++ b/tests/boards/intel_s1000_crb/src/gpio_test.c @@ -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 * -------------------- diff --git a/tests/boards/intel_s1000_crb/src/i2c_test.c b/tests/boards/intel_s1000_crb/src/i2c_test.c index f057b08a315..5088530df4f 100644 --- a/tests/boards/intel_s1000_crb/src/i2c_test.c +++ b/tests/boards/intel_s1000_crb/src/i2c_test.c @@ -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 * -------------------- diff --git a/tests/boards/intel_s1000_crb/src/i2s_test.c b/tests/boards/intel_s1000_crb/src/i2s_test.c index fa901c411a0..018ba59a404 100644 --- a/tests/boards/intel_s1000_crb/src/i2s_test.c +++ b/tests/boards/intel_s1000_crb/src/i2s_test.c @@ -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 * -------------------- diff --git a/tests/include/tc_util.h b/tests/include/tc_util.h index 555e7fbffac..a7ae08d92b0 100644 --- a/tests/include/tc_util.h +++ b/tests/include/tc_util.h @@ -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