michaelh/zephyr
1
0
Fork 0
Code Releases Activity

tests: remove @return doc for void functions

Browse source 
For functions returning nothing, there is no need to document
with @return, as Doxgen complains about "documented empty
return type of ...".

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2022-01-06 17:22:25 -08:00 • committed by Anas Nashif
commit 8f7f62869a
36 changed files with 1 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

3
tests/arch/arm/arm_irq_vector_table/src/arm_irq_vector_table.c
View file

@ -83,7 +83,6 @@ struct k_sem sem[3];
*
* @brief ISR for IRQ0
*
* @return N/A
*/
void isr0(void)
@ -97,7 +96,6 @@ void isr0(void)
*
* @brief ISR for IRQ1
*
* @return N/A
*/
void isr1(void)
@ -111,7 +109,6 @@ void isr1(void)
*
* @brief ISR for IRQ2
*
* @return N/A
*/
void isr2(void)

3
tests/arch/x86/static_idt/src/main.c
View file

@ -63,8 +63,6 @@ void k_sys_fatal_error_handler(unsigned int reason, const z_arch_esf_t *esf)
* Handler to perform various actions from within an ISR context
*
* This routine is the ISR handler for _trigger_isr_handler().
*
* @return N/A
*/
void isr_handler(void)
@ -89,7 +87,6 @@ void isr_handler(void)
* done, then control goes back to the offending instruction and an infinite
* loop of divide-by-zero errors would be created.)
*
* @return N/A
*/
void exc_divide_error_handler(z_arch_esf_t *p_esf)

1
tests/benchmarks/app_kernel/src/fifo_b.c
View file

@ -14,7 +14,6 @@
*
* @brief Queue transfer speed test
*
* @return N/A
*/
void queue_test(void)
{

1
tests/benchmarks/app_kernel/src/fifo_r.c
View file

@ -16,7 +16,6 @@
*
* @brief Data receive task
*
* @return N/A
*/
void dequtask(void)
{

2
tests/benchmarks/app_kernel/src/mailbox_b.c
View file

@ -71,7 +71,6 @@ void mailbox_put(uint32_t size, int count, uint32_t *time);
*
* @brief Mailbox transfer speed test
*
* @return N/A
*/
void mailbox_test(void)
{
@ -125,7 +124,6 @@ void mailbox_test(void)
* @param count Number of data chunks.
* @param time The total time.
*
* @return N/A
*/
void mailbox_put(uint32_t size, int count, uint32_t *time)
{

1
tests/benchmarks/app_kernel/src/mailbox_r.c
View file

@ -29,7 +29,6 @@ void mailbox_get(struct k_mbox *mailbox,
*
* @brief Receive task
*
* @return N/A
*/
void mailrecvtask(void)
{

6
tests/benchmarks/app_kernel/src/master.c
View file

@ -77,10 +77,9 @@ int kbhit(void)
*
* @brief Prepares the test output
*
* @return N/A
*
* @param continuously Run test till the user presses the key.
* @param autorun Expect user input.
*
*/
void init_output(int *continuously, int *autorun)
{
@ -97,7 +96,6 @@ void init_output(int *continuously, int *autorun)
*
* @brief Close output for the test
*
* @return N/A
*/
void output_close(void)
{
@ -112,7 +110,6 @@ void output_close(void)
* @brief Perform all selected benchmarks
* see config.h to select or to unselect
*
* @return N/A
*/
void main(void)
{
@ -154,7 +151,6 @@ void main(void)
*
* @brief Dummy test
*
* @return N/A
*/
void dummy_test(void)
{

1
tests/benchmarks/app_kernel/src/memmap_b.c
View file

@ -16,7 +16,6 @@
*
* @brief Memory map get/free test
*
* @return N/A
*/
void memorymap_test(void)
{

1
tests/benchmarks/app_kernel/src/mutex_b.c
View file

@ -14,7 +14,6 @@
*
* @brief Mutex lock/unlock test
*
* @return N/A
*/
void mutex_test(void)
{

1
tests/benchmarks/app_kernel/src/pipe_b.c
View file

@ -91,7 +91,6 @@ int pipeput(struct k_pipe *pipe, enum pipe_options
*
* @brief Test the pipes transfer speed
*
* @return N/A
*/
void pipe_test(void)
{

1
tests/benchmarks/app_kernel/src/pipe_r.c
View file

@ -28,7 +28,6 @@ int pipeget(struct k_pipe *pipe, enum pipe_options option,
*
* @brief Receive task
*
* @return N/A
*/
void piperecvtask(void)
{

1
tests/benchmarks/app_kernel/src/receiver.c
View file

@ -28,7 +28,6 @@ void piperecvtask(void);
*
* @brief Main function of the task that receives data in the test
*
* @return N/A
*/
void recvtask(void *p1, void *p2, void *p3)
{

1
tests/benchmarks/app_kernel/src/sema_b.c
View file

@ -15,7 +15,6 @@
*
* @brief Semaphore signal speed test
*
* @return N/A
*/
void sema_test(void)
{

1
tests/benchmarks/app_kernel/src/sema_r.c
View file

@ -17,7 +17,6 @@
*
* @brief Receive task (Wait task)
*
* @return N/A
*/
void waittask(void)
{

1
tests/benchmarks/latency_measure/src/coop_ctx_switch.c
View file

@ -50,7 +50,6 @@ K_SEM_DEFINE(sync_sema, 0, 1);
* Fiber makes all the test preparations: registers the interrupt handler,
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*/
static void thread_one(void)
{

2
tests/benchmarks/latency_measure/src/int_to_thread.c
View file

@ -30,7 +30,6 @@ static timing_t timestamp_end;
*
* The interrupt handler gets the second timestamp.
*
* @return N/A
*/
static void latency_test_isr(const void *unused)
{
@ -47,7 +46,6 @@ static void latency_test_isr(const void *unused)
* Function makes all the test preparations: registers the interrupt handler,
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*/
static void make_int(void)
{

1
tests/benchmarks/latency_measure/src/int_to_thread_evt.c
View file

@ -33,7 +33,6 @@ K_SEM_DEFINE(WORKSEMA, 0, 1);
*
* The interrupt handler gets the second timestamp.
*
* @return N/A
*/
static void latency_test_isr(const void *unused)
{

4
tests/benchmarks/latency_measure/src/thread_switch_yield.c
View file

@ -30,8 +30,6 @@ static struct k_thread y_thread;
/**
* @brief Helper thread for measuring thread switch latency using yield
*
* @return N/A
*/
void yielding_thread(void *arg1, void *arg2, void *arg3)
{
@ -43,8 +41,6 @@ void yielding_thread(void *arg1, void *arg2, void *arg3)
/**
* @brief Entry point for thread context switch using yield test
*
* @return N/A
*/
void thread_switch_yield(void)
{

4
tests/benchmarks/sys_kernel/src/lifo.c
View file

@ -17,7 +17,6 @@ static struct k_fifo sync_fifo; /* for synchronization */
*
* @brief Initialize LIFOs for the test
*
* @return N/A
*/
void lifo_test_init(void)
{
@ -34,7 +33,6 @@ void lifo_test_init(void)
* @param par2 Number of test loops.
* @param par3 unused
*
* @return N/A
*/
void lifo_thread1(void *par1, void *par2, void *par3)
{
@ -73,7 +71,6 @@ void lifo_thread1(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 unused
*
* @return N/A
*/
void lifo_thread2(void *par1, void *par2, void *par3)
{
@ -104,7 +101,6 @@ void lifo_thread2(void *par1, void *par2, void *par3)
* @param par2 Number of test loops.
* @param par3 unused
*
* @return N/A
*/
void lifo_thread3(void *par1, void *par2, void *par3)
{

4
tests/benchmarks/sys_kernel/src/mwfifo.c
View file

@ -19,7 +19,6 @@ static struct k_fifo sync_fifo; /* for synchronization */
*
* @brief Initialize FIFOs for the test
*
* @return N/A
*/
void fifo_test_init(void)
{
@ -36,7 +35,6 @@ void fifo_test_init(void)
* @param par2 Number of test loops.
* @param par3 unused
*
* @return N/A
*/
void fifo_thread1(void *par1, void *par2, void *par3)
{
@ -68,7 +66,6 @@ void fifo_thread1(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 unused
*
* @return N/A
*/
void fifo_thread2(void *par1, void *par2, void *par3)
{
@ -102,7 +99,6 @@ void fifo_thread2(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 unused
*
* @return N/A
*/
void fifo_thread3(void *par1, void *par2, void *par3)
{

4
tests/benchmarks/sys_kernel/src/sema.c
View file

@ -15,7 +15,6 @@ struct k_sem sem2;
*
* @brief Initialize semaphores for the test
*
* @return N/A
*/
void sema_test_init(void)
{
@ -32,7 +31,6 @@ void sema_test_init(void)
* @param par2 Number of test loops.
* @param par3 Unused
*
* @return N/A
*/
void sema_thread1(void *par1, void *par2, void *par3)
{
@ -57,7 +55,6 @@ void sema_thread1(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*/
void sema_thread2(void *par1, void *par2, void *par3)
{
@ -82,7 +79,6 @@ void sema_thread2(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*/
void sema_thread3(void *par1, void *par2, void *par3)
{

8
tests/benchmarks/sys_kernel/src/stack.c
View file

@ -18,8 +18,6 @@ stack_data_t stack2[2];
*
* @brief Initialize stacks for the test
*
* @return N/A
*
*/
void stack_test_init(void)
{
@ -36,8 +34,6 @@ void stack_test_init(void)
* @param par2 Number of test loops.
* @param par3 Unused
*
* @return N/A
*
*/
void stack_thread1(void *par1, void *par2, void *par3)
{
@ -73,8 +69,6 @@ void stack_thread1(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*
*/
void stack_thread2(void *par1, void *par2, void *par3)
{
@ -105,8 +99,6 @@ void stack_thread2(void *par1, void *par2, void *par3)
* @param par2 Number of test cycles.
* @param par3 Unused
*
* @return N/A
*
*/
void stack_thread3(void *par1, void *par2, void *par3)
{

4
tests/benchmarks/sys_kernel/src/syskernel.c
View file

@ -38,7 +38,6 @@ uint32_t number_of_loops;
*
* Routine does necessary preparations for the test to start
*
* @return N/A
*/
void begin_test(void)
{
@ -94,7 +93,6 @@ int check_result(int i, uint32_t t)
*
* @param continuously Run test till the user presses the key.
*
* @return N/A
*/
void init_output(int *continuously)
@ -112,7 +110,6 @@ void init_output(int *continuously)
*
* @brief Close output for the test
*
* @return N/A
*/
void output_close(void)
{
@ -122,7 +119,6 @@ void output_close(void)
*
* @brief Perform all selected benchmarks
*
* @return N/A
*/
void main(void)
{

2
tests/crypto/rand32/src/main.c
View file

@ -24,8 +24,6 @@
*
* @brief Regression test's entry point
*
*
* @return N/A
*/
void test_rand32(void)

7
tests/kernel/context/src/main.c
View file

@ -219,8 +219,6 @@ static void test_kernel_cpu_idle_atomic(void);
*
* This routine is the ISR handler for isr_handler_trigger(). It performs
* the command requested in <isr_info.command>.
*
* @return N/A
*/
static void isr_handler(const void *data)
{
@ -285,8 +283,6 @@ int irq_lock_wrapper(int unused)
/**
* @brief A wrapper for irq_unlock()
*
* @return N/A
*/
void irq_unlock_wrapper(int imask)
{
@ -306,8 +302,6 @@ int irq_disable_wrapper(int irq)
/**
* @brief A wrapper for irq_enable()
*
* @return N/A
*/
void irq_enable_wrapper(int irq)
{
@ -760,7 +754,6 @@ static void _test_kernel_thread(k_tid_t _thread_id)
* @param arg2 unused
* @param arg3 unused
*
* @return N/A
*/
static void thread_helper(void *arg1, void *arg2, void *arg3)

3
tests/kernel/fpu_sharing/generic/src/float_regs_arc_gcc.h
View file

@ -34,7 +34,6 @@
* _load_all_float_registers() and _store_all_float_registers() agree
* on the format.
*
* @return N/A
*/
static inline void _load_all_float_registers(struct fp_register_set *regs)
{
@ -67,7 +66,6 @@ static inline void _load_all_float_registers(struct fp_register_set *regs)
* _load_all_float_registers() occurred to load all the floating point
* registers from a memory buffer.
*
* @return N/A
*/
static inline void _store_all_float_registers(struct fp_register_set *regs)
@ -102,7 +100,6 @@ static inline void _store_all_float_registers(struct fp_register_set *regs)
* that pends and triggers a co-operative context switch to a low priority
* thread.
*
* @return N/A
*/
static inline void _load_then_store_all_float_registers(struct fp_register_set

3
tests/kernel/fpu_sharing/generic/src/float_regs_arm64_gcc.h
View file

@ -30,7 +30,6 @@
* _load_all_float_registers() and _store_all_float_registers() agree
* on the format.
*
* @return N/A
*/
static inline void _load_all_float_registers(struct fp_register_set *regs)
{
@ -65,7 +64,6 @@ static inline void _load_all_float_registers(struct fp_register_set *regs)
* _load_all_float_registers() occurred to load all the floating point
* registers from a memory buffer.
*
* @return N/A
*/
static inline void _store_all_float_registers(struct fp_register_set *regs)
@ -104,7 +102,6 @@ static inline void _store_all_float_registers(struct fp_register_set *regs)
* that pends and triggers a co-operative context switch to a low priority
* thread.
*
* @return N/A
*/
static inline void _load_then_store_all_float_registers(

3
tests/kernel/fpu_sharing/generic/src/float_regs_arm_gcc.h
View file

@ -34,7 +34,6 @@
* _load_all_float_registers() and _store_all_float_registers() agree
* on the format.
*
* @return N/A
*/
static inline void _load_all_float_registers(struct fp_register_set *regs)
@ -55,7 +54,6 @@ static inline void _load_all_float_registers(struct fp_register_set *regs)
* _load_all_float_registers() occurred to load all the floating point
* registers from a memory buffer.
*
* @return N/A
*/
static inline void _store_all_float_registers(struct fp_register_set *regs)
@ -79,7 +77,6 @@ static inline void _store_all_float_registers(struct fp_register_set *regs)
* that pends and triggers a co-operative context switch to a low priority
* thread.
*
* @return N/A
*/
static inline void _load_then_store_all_float_registers(struct fp_register_set

3
tests/kernel/fpu_sharing/generic/src/float_regs_riscv_gcc.h
View file

@ -44,7 +44,6 @@
* _load_all_float_registers() and _store_all_float_registers() agree
* on the format.
*
* @return N/A
*/
static inline void _load_all_float_registers(struct fp_register_set *regs)
{
@ -129,7 +128,6 @@ static inline void _load_all_float_registers(struct fp_register_set *regs)
* _load_all_float_registers() occurred to load all the floating point
* registers from a memory buffer.
*
* @return N/A
*/
static inline void _store_all_float_registers(struct fp_register_set *regs)
@ -217,7 +215,6 @@ static inline void _store_all_float_registers(struct fp_register_set *regs)
* that pends and triggers a co-operative context switch to a low priority
* thread.
*
* @return N/A
*/
static inline void _load_then_store_all_float_registers(struct fp_register_set

3
tests/kernel/fpu_sharing/generic/src/float_regs_x86_gcc.h
View file

@ -34,7 +34,6 @@
* _load_all_float_registers(), _store_all_float_registers() and
* _load_then_store_all_float_registers() agree on the format.
*
* @return N/A
*/
static inline void _load_all_float_registers(struct fp_register_set *regs)
@ -78,7 +77,6 @@ static inline void _load_all_float_registers(struct fp_register_set *regs)
* floating point operations was also co-operatively switched out and simply
* inherits the existing x87 FPU state (expecting the stack to be empty).
*
* @return N/A
*/
static inline void
@ -128,7 +126,6 @@ _load_then_store_all_float_registers(struct fp_register_set *regs)
* _load_all_float_registers() occurred to load all the floating point
* registers from a memory buffer.
*
* @return N/A
*/
static inline void _store_all_float_registers(struct fp_register_set *regs)

3
tests/kernel/mem_protect/stackprot/src/main.c
View file

@ -34,7 +34,6 @@ void check_input(const char *name, const char *input);
*
* @param name caller identification string
*
* @return N/A
*/
void print_loop(const char *name)
@ -59,7 +58,6 @@ void print_loop(const char *name)
* When stack protection feature is not enabled, the system crashes with
* error like: Trying to execute code outside RAM or ROM.
*
* @return N/A
*/
void check_input(const char *name, const char *input)
@ -78,7 +76,6 @@ void check_input(const char *name, const char *input)
* feature is enabled. Hence it will not execute the print_loop function
* and will not set ret to TC_FAIL.
*
* @return N/A
*/
void alternate_thread(void)
{

3
tests/kernel/mem_slab/mslab/src/main.c
View file

@ -54,7 +54,6 @@ K_MEM_SLAB_DEFINE(map_lgblks, 1024, NUMBLOCKS, 4);
* SEM_REGRESDONE and SEM_HELPERDONE to synchronize between different parts
* of the test.
*
* @return N/A
*/
void helper_thread(void)
@ -122,7 +121,6 @@ void helper_thread(void)
*
* @param p pointer to pointer of allocated blocks
*
* @return TC_PASS, TC_FAIL
*/
void test_slab_get_all_blocks(void **p)
@ -165,7 +163,6 @@ void test_slab_get_all_blocks(void **p)
*
* @param p pointer to pointer of allocated blocks
*
* @return TC_PASS, TC_FAIL
*/
void test_slab_free_all_blocks(void **p)

7
tests/kernel/mutex/sys_mutex/src/main.c
View file

@ -73,7 +73,6 @@ extern void test_mutex_multithread_competition(void);
*
* thread_05 -
*
* @return N/A
*/
void thread_05(void)
@ -96,7 +95,6 @@ void thread_05(void)
*
* thread_06 -
*
* @return N/A
*/
void thread_06(void)
@ -128,7 +126,6 @@ void thread_06(void)
*
* thread_07 -
*
* @return N/A
*/
void thread_07(void)
@ -158,7 +155,6 @@ void thread_07(void)
*
* thread_08 -
*
* @return N/A
*/
void thread_08(void)
@ -182,7 +178,6 @@ void thread_08(void)
*
* thread_09 -
*
* @return N/A
*/
void thread_09(void)
@ -215,7 +210,6 @@ void thread_09(void)
*
* thread_11 -
*
* @return N/A
*/
void thread_11(void)
@ -243,7 +237,6 @@ extern void thread_12(void);
* This thread will lock on mutex_1, mutex_2, mutex_3 and mutex_4. It later
* recursively locks private_mutex, releases it, then re-locks it.
*
* @return N/A
*/
void test_mutex(void)

1
tests/kernel/mutex/sys_mutex/src/thread_12.c
View file

@ -27,7 +27,6 @@ extern struct sys_mutex private_mutex;
*
* thread_12 - thread that participates in recursive locking tests
*
* @return N/A
*/
void thread_12(void)

2
tests/kernel/workq/user_work/src/main.c
View file

@ -32,8 +32,6 @@ static struct k_thread *main_thread;
*
* @param unused of type k_work to make handler function accepted
* by k_work_init
*
* @return N/A
*/
static void common_work_handler(struct k_work_user *unused)
{

1
tests/lib/sprintf/src/main.c
View file

@ -943,7 +943,6 @@ void test_EOF(void)
*
* @brief Test entry point
*
* @return N/A
*/
void test_main(void)