Skip to content

Commit 7d36a18

Browse files
nashifkartben
authored andcommitted
tests: kernel: fix kheap doxygen groups
Fix grouping and general doxygen fixups. Signed-off-by: Anas Nashif <[email protected]>
1 parent d837b64 commit 7d36a18

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

tests/kernel/mem_heap/k_heap_api/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
#include <zephyr/ztest.h>
88

99
/**
10-
* @brief k heap api tests
10+
* @brief Kernel Heap API Tests
1111
*
12-
* @defgroup k_heap api Tests
12+
* @defgroup k_heap_api_tests Kernel Heap Tests
1313
*
1414
* @ingroup all_tests
1515
* @{

tests/kernel/mem_heap/k_heap_api/src/test_kheap_api.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ K_HEAP_DEFINE(tiny_heap, 1);
7272
volatile uint32_t heap_guard1;
7373

7474
/** @brief Test a minimum-size static k_heap
75-
* @ingroup kernel_kheap_api_tests
75+
* @ingroup k_heap_api_tests
7676
*
7777
* @details Create a minimum size (1-byte) static heap, verify that it
7878
* works to allocate that byte at runtime and that it doesn't overflow
@@ -105,7 +105,7 @@ ZTEST(k_heap_api, test_k_heap_min_size)
105105
/**
106106
* @brief Test to demonstrate k_heap_alloc() and k_heap_free() API usage
107107
*
108-
* @ingroup kernel_kheap_api_tests
108+
* @ingroup k_heap_api_tests
109109
*
110110
* @details The test allocates 1024 bytes from 2048 byte heap,
111111
* and checks if allocation is successful or not
@@ -129,7 +129,7 @@ ZTEST(k_heap_api, test_k_heap_alloc)
129129
/**
130130
* @brief Test to demonstrate k_heap_alloc() and k_heap_free() API usage
131131
*
132-
* @ingroup kernel_kheap_api_tests
132+
* @ingroup k_heap_api_tests
133133
*
134134
* @details The test allocates 2049 bytes, which is greater than the heap
135135
* size(2048 bytes), and checks for NULL return from k_heap_alloc
@@ -151,7 +151,7 @@ ZTEST(k_heap_api, test_k_heap_alloc_fail)
151151
/**
152152
* @brief Test to demonstrate k_heap_free() API functionality.
153153
*
154-
* @ingroup kernel_kheap_api_tests
154+
* @ingroup k_heap_api_tests
155155
*
156156
* @details The test validates k_heap_free()
157157
* API, by using below steps
@@ -184,7 +184,7 @@ ZTEST(k_heap_api, test_k_heap_free)
184184
* @details The test validates k_heap_alloc() in isr context, the timeout
185185
* param should be K_NO_WAIT, because this situation isn't allow to wait.
186186
*
187-
* @ingroup kernel_heap_tests
187+
* @ingroup k_heap_api_tests
188188
*/
189189
ZTEST(k_heap_api, test_kheap_alloc_in_isr_nowait)
190190
{
@@ -198,7 +198,7 @@ ZTEST(k_heap_api, test_kheap_alloc_in_isr_nowait)
198198
* child thread. If there isn't enough space in the heap, the child thread
199199
* will wait timeout long until main thread free the buffer to heap.
200200
*
201-
* @ingroup kernel_heap_tests
201+
* @ingroup k_heap_api_tests
202202
*/
203203
ZTEST(k_heap_api, test_k_heap_alloc_pending)
204204
{
@@ -235,7 +235,7 @@ ZTEST(k_heap_api, test_k_heap_alloc_pending)
235235
* will wait timeout long until main thread free one of the buffer to heap, space in
236236
* the heap is still not enough and then return null after timeout.
237237
*
238-
* @ingroup kernel_heap_tests
238+
* @ingroup k_heap_api_tests
239239
*/
240240
ZTEST(k_heap_api, test_k_heap_alloc_pending_null)
241241
{
@@ -271,7 +271,7 @@ ZTEST(k_heap_api, test_k_heap_alloc_pending_null)
271271
/**
272272
* @brief Test to demonstrate k_heap_calloc() and k_heap_free() API usage
273273
*
274-
* @ingroup kernel_kheap_api_tests
274+
* @ingroup k_heap_api_tests
275275
*
276276
* @details The test allocates 256 unsigned integers of 4 bytes for a
277277
* total of 1024 bytes from the 2048 byte heap. It checks if allocation

tests/lib/multi_heap/src/test_mheap_api.c

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ static void realloc_handler(void *p1, void *p2, void *p3)
180180
/**
181181
* @brief Test to demonstrate k_malloc() and k_free() API usage
182182
*
183-
* @ingroup kernel_heap_tests
183+
* @ingroup k_heap_api_tests
184184
*
185185
* @details The test allocates 4 blocks from heap memory pool
186186
* using k_malloc() API. It also tries to allocate a block of size
@@ -225,7 +225,7 @@ ZTEST(mheap_api, test_mheap_realloc)
225225
/**
226226
* @brief Test to demonstrate k_calloc() API functionality.
227227
*
228-
* @ingroup kernel_heap_tests
228+
* @ingroup k_heap_api_tests
229229
*
230230
* @details The test validates k_calloc() API. When requesting a
231231
* huge size of space or a space larger than heap memory,
@@ -299,7 +299,7 @@ ZTEST(mheap_api, test_k_aligned_alloc)
299299
* a block of memory smaller than the pool and will fail when alloc
300300
* a block of memory larger than the pool.
301301
*
302-
* @ingroup kernel_heap_tests
302+
* @ingroup k_heap_api_tests
303303
*
304304
* @see k_thread_system_pool_assign(), z_thread_malloc(), k_free()
305305
*/
@@ -328,7 +328,7 @@ ZTEST(mheap_api, test_sys_heap_mem_pool_assign)
328328
* memory because in this situation, the kernel will assign the heap memory
329329
* as resource pool.
330330
*
331-
* @ingroup kernel_heap_tests
331+
* @ingroup k_heap_api_tests
332332
*
333333
* @see z_thread_malloc(), k_free()
334334
*/
@@ -347,7 +347,7 @@ ZTEST(mheap_api, test_malloc_in_isr)
347347
*
348348
* @details When a thread's resource pool is not assigned, alloc memory will fail.
349349
*
350-
* @ingroup kernel_heap_tests
350+
* @ingroup k_heap_api_tests
351351
*
352352
* @see z_thread_malloc()
353353
*/

tests/lib/multi_heap/src/test_mheap_concept.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ static void tmheap_malloc_align4_handler(void *p1, void *p2, void *p3)
4949
/**
5050
* @brief The test validates k_calloc() API.
5151
*
52-
* @ingroup kernel_heap_tests
52+
* @ingroup k_heap_api_tests
5353
*
5454
* @details The 8 blocks of memory of size 16 bytes are allocated
5555
* by k_calloc() API. When allocated using k_calloc() the memory buffers

0 commit comments

Comments
 (0)