tests: workqueue: add API references and doxygen group

Add a doxygen group and reference tested APIs using @see.

Signed-off-by: Anas Nashif <[email protected]>

Author: nashif

tests/kernel/workq/work_queue/src/main.c

@@ -46,6 +46,10 @@ static void work_handler(struct k_work *work)
 	results[num_results++] = ti->key;
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_work_init()
+ */
 static void test_items_init(void)
 {
 	int i;
@@ -83,6 +87,10 @@ static void coop_work_main(int arg1, int arg2)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_work_submit()
+ */
 static void test_items_submit(void)
 {
 	int i;
@@ -115,6 +123,10 @@ static void check_results(int num_tests)
 
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_work_init(), k_work_submit()
+ */
 static void test_sequence(void)
 {
 	TC_PRINT(" - Initializing test items\n");
@@ -146,7 +158,10 @@ static void resubmit_work_handler(struct k_work *work)
 		k_work_submit(work);
 	}
 }
-
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_work_submit()
+ */
 static void test_resubmit(void)
 {
 	TC_PRINT("Starting resubmit test\n");
@@ -174,6 +189,10 @@ static void delayed_work_handler(struct k_work *work)
 	results[num_results++] = ti->key;
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init()
+ */
 static void test_delayed_init(void)
 {
 	int i;
@@ -202,6 +221,10 @@ static void coop_delayed_work_main(int arg1, int arg2)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init(), k_delayed_work_submit()
+ */
 static void test_delayed_submit(void)
 {
 	int i;
@@ -237,6 +260,10 @@ static void coop_delayed_work_cancel_main(int arg1, int arg2)
 #endif
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init(), k_delayed_work_submit(), k_delayed_work_cancel()
+ */
 static void test_delayed_cancel(void)
 {
 	TC_PRINT("Starting delayed cancel test\n");
@@ -257,6 +284,10 @@ static void test_delayed_cancel(void)
 	check_results(0);
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init(), k_delayed_work_submit()
+ */
 static void delayed_resubmit_work_handler(struct k_work *work)
 {
 	struct test_item *ti = CONTAINER_OF(work, struct test_item, work);
@@ -270,6 +301,10 @@ static void delayed_resubmit_work_handler(struct k_work *work)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init(), k_delayed_work_submit()
+ */
 static void test_delayed_resubmit(void)
 {
 	TC_PRINT("Starting delayed resubmit test\n");
@@ -308,6 +343,11 @@ static void coop_delayed_work_resubmit(void)
 	}
 }
 
+
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init()
+ */
 static void test_delayed_resubmit_thread(void)
 {
 	TC_PRINT("Starting delayed resubmit from coop thread test\n");
@@ -327,6 +367,10 @@ static void test_delayed_resubmit_thread(void)
 	reset_results();
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ * @see k_delayed_work_init(), k_delayed_work_submit()
+ */
 static void test_delayed(void)
 {
 	TC_PRINT("Starting delayed test\n");

tests/kernel/workq/work_queue_api/src/main.c

@@ -4,6 +4,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/**
+ * @brief Workqueue Tests
+ * @defgroup workqueue_thread_tests Workqueue
+ * @ingroup all_tests
+ * @{
+ * @}
+ */
 
 #include <ztest.h>
 #include <irq_offload.h>
@@ -183,13 +190,23 @@ static void tdelayed_work_cancel(void *data)
 }
 
 /*test cases*/
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_work_q_start()
+ */
 void test_workq_start_before_submit(void)
 {
 	k_sem_init(&sync_sema, 0, NUM_OF_WORK);
 	k_work_q_start(&workq, tstack, STACK_SIZE,
 		       CONFIG_MAIN_THREAD_PRIORITY);
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), k_work_submit()
+ */
 void test_work_submit_to_queue_thread(void)
 {
 	k_sem_reset(&sync_sema);
@@ -199,6 +216,11 @@ void test_work_submit_to_queue_thread(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_init(), k_delayed_work_submit_to_queue(), k_delayed_work_submit()
+ */
 void test_work_submit_to_multipleq(void)
 {
 	k_sem_reset(&sync_sema);
@@ -208,13 +230,23 @@ void test_work_submit_to_multipleq(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_queue_remove(), k_delayed_work_init(), k_delayed_work_submit_to_queue()
+ */
 void test_work_resubmit_to_queue(void)
 {
 	k_sem_reset(&sync_sema);
 	twork_resubmit(&workq);
 	k_sem_take(&sync_sema, K_FOREVER);
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), k_work_submit()
+ */
 void test_work_submit_to_queue_isr(void)
 {
 	k_sem_reset(&sync_sema);
@@ -224,6 +256,11 @@ void test_work_submit_to_queue_isr(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), k_work_submit()
+ */
 void test_work_submit_thread(void)
 {
 	k_sem_reset(&sync_sema);
@@ -233,6 +270,11 @@ void test_work_submit_thread(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_work_init(), k_work_pending(), k_work_submit_to_queue(), k_work_submit()
+ */
 void test_work_submit_isr(void)
 {
 	k_sem_reset(&sync_sema);
@@ -242,6 +284,13 @@ void test_work_submit_isr(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_init(), k_work_pending(),
+ * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(),
+ * k_delayed_work_submit()
+ */
 void test_delayed_work_submit_to_queue_thread(void)
 {
 	k_sem_reset(&sync_sema);
@@ -251,6 +300,13 @@ void test_delayed_work_submit_to_queue_thread(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_init(), k_work_pending(),
+ * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(),
+ * k_delayed_work_submit()
+ */
 void test_delayed_work_submit_to_queue_isr(void)
 {
 	k_sem_reset(&sync_sema);
@@ -260,6 +316,13 @@ void test_delayed_work_submit_to_queue_isr(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_init(), k_work_pending(),
+ * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(),
+ * k_delayed_work_submit()
+ */
 void test_delayed_work_submit_thread(void)
 {
 	k_sem_reset(&sync_sema);
@@ -269,6 +332,13 @@ void test_delayed_work_submit_thread(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_init(), k_work_pending(),
+ * k_delayed_work_remaining_get(), k_delayed_work_submit_to_queue(),
+ * k_delayed_work_submit()
+ */
 void test_delayed_work_submit_isr(void)
 {
 	k_sem_reset(&sync_sema);
@@ -278,6 +348,11 @@ void test_delayed_work_submit_isr(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_cancel(), k_work_pending()
+ */
 void test_delayed_work_cancel_from_queue_thread(void)
 {
 	k_sem_reset(&sync_sema);
@@ -288,6 +363,11 @@ void test_delayed_work_cancel_from_queue_thread(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_cancel(), k_work_pending()
+ */
 void test_delayed_work_cancel_from_queue_isr(void)
 {
 	k_sem_reset(&sync_sema);
@@ -298,6 +378,11 @@ void test_delayed_work_cancel_from_queue_isr(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_cancel(), k_work_pending()
+ */
 void test_delayed_work_cancel_thread(void)
 {
 	k_sem_reset(&sync_sema);
@@ -308,6 +393,11 @@ void test_delayed_work_cancel_thread(void)
 	}
 }
 
+/**
+ * @ingroup workqueue_thread_tests
+ *
+ * @see k_delayed_work_cancel(), k_work_pending()
+ */
 void test_delayed_work_cancel_isr(void)
 {
 	k_sem_reset(&sync_sema);