tests: kernel: fix kheap doxygen groups
Fix grouping and general doxygen fixups. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
d837b644dd
commit
7d36a18b7b
4 changed files with 16 additions and 16 deletions
|
@ -7,9 +7,9 @@
|
|||
#include <zephyr/ztest.h>
|
||||
|
||||
/**
|
||||
* @brief k heap api tests
|
||||
* @brief Kernel Heap API Tests
|
||||
*
|
||||
* @defgroup k_heap api Tests
|
||||
* @defgroup k_heap_api_tests Kernel Heap Tests
|
||||
*
|
||||
* @ingroup all_tests
|
||||
* @{
|
||||
|
|
|
@ -72,7 +72,7 @@ K_HEAP_DEFINE(tiny_heap, 1);
|
|||
volatile uint32_t heap_guard1;
|
||||
|
||||
/** @brief Test a minimum-size static k_heap
|
||||
* @ingroup kernel_kheap_api_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details Create a minimum size (1-byte) static heap, verify that it
|
||||
* 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)
|
|||
/**
|
||||
* @brief Test to demonstrate k_heap_alloc() and k_heap_free() API usage
|
||||
*
|
||||
* @ingroup kernel_kheap_api_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The test allocates 1024 bytes from 2048 byte heap,
|
||||
* and checks if allocation is successful or not
|
||||
|
@ -129,7 +129,7 @@ ZTEST(k_heap_api, test_k_heap_alloc)
|
|||
/**
|
||||
* @brief Test to demonstrate k_heap_alloc() and k_heap_free() API usage
|
||||
*
|
||||
* @ingroup kernel_kheap_api_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The test allocates 2049 bytes, which is greater than the heap
|
||||
* 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)
|
|||
/**
|
||||
* @brief Test to demonstrate k_heap_free() API functionality.
|
||||
*
|
||||
* @ingroup kernel_kheap_api_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The test validates k_heap_free()
|
||||
* API, by using below steps
|
||||
|
@ -184,7 +184,7 @@ ZTEST(k_heap_api, test_k_heap_free)
|
|||
* @details The test validates k_heap_alloc() in isr context, the timeout
|
||||
* param should be K_NO_WAIT, because this situation isn't allow to wait.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*/
|
||||
ZTEST(k_heap_api, test_kheap_alloc_in_isr_nowait)
|
||||
{
|
||||
|
@ -198,7 +198,7 @@ ZTEST(k_heap_api, test_kheap_alloc_in_isr_nowait)
|
|||
* child thread. If there isn't enough space in the heap, the child thread
|
||||
* will wait timeout long until main thread free the buffer to heap.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*/
|
||||
ZTEST(k_heap_api, test_k_heap_alloc_pending)
|
||||
{
|
||||
|
@ -235,7 +235,7 @@ ZTEST(k_heap_api, test_k_heap_alloc_pending)
|
|||
* will wait timeout long until main thread free one of the buffer to heap, space in
|
||||
* the heap is still not enough and then return null after timeout.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*/
|
||||
ZTEST(k_heap_api, test_k_heap_alloc_pending_null)
|
||||
{
|
||||
|
@ -271,7 +271,7 @@ ZTEST(k_heap_api, test_k_heap_alloc_pending_null)
|
|||
/**
|
||||
* @brief Test to demonstrate k_heap_calloc() and k_heap_free() API usage
|
||||
*
|
||||
* @ingroup kernel_kheap_api_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The test allocates 256 unsigned integers of 4 bytes for a
|
||||
* total of 1024 bytes from the 2048 byte heap. It checks if allocation
|
||||
|
|
|
@ -180,7 +180,7 @@ static void realloc_handler(void *p1, void *p2, void *p3)
|
|||
/**
|
||||
* @brief Test to demonstrate k_malloc() and k_free() API usage
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The test allocates 4 blocks from heap memory pool
|
||||
* using k_malloc() API. It also tries to allocate a block of size
|
||||
|
@ -225,7 +225,7 @@ ZTEST(mheap_api, test_mheap_realloc)
|
|||
/**
|
||||
* @brief Test to demonstrate k_calloc() API functionality.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The test validates k_calloc() API. When requesting a
|
||||
* huge size of space or a space larger than heap memory,
|
||||
|
@ -299,7 +299,7 @@ ZTEST(mheap_api, test_k_aligned_alloc)
|
|||
* a block of memory smaller than the pool and will fail when alloc
|
||||
* a block of memory larger than the pool.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @see k_thread_system_pool_assign(), z_thread_malloc(), k_free()
|
||||
*/
|
||||
|
@ -328,7 +328,7 @@ ZTEST(mheap_api, test_sys_heap_mem_pool_assign)
|
|||
* memory because in this situation, the kernel will assign the heap memory
|
||||
* as resource pool.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @see z_thread_malloc(), k_free()
|
||||
*/
|
||||
|
@ -347,7 +347,7 @@ ZTEST(mheap_api, test_malloc_in_isr)
|
|||
*
|
||||
* @details When a thread's resource pool is not assigned, alloc memory will fail.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @see z_thread_malloc()
|
||||
*/
|
||||
|
|
|
@ -49,7 +49,7 @@ static void tmheap_malloc_align4_handler(void *p1, void *p2, void *p3)
|
|||
/**
|
||||
* @brief The test validates k_calloc() API.
|
||||
*
|
||||
* @ingroup kernel_heap_tests
|
||||
* @ingroup k_heap_api_tests
|
||||
*
|
||||
* @details The 8 blocks of memory of size 16 bytes are allocated
|
||||
* by k_calloc() API. When allocated using k_calloc() the memory buffers
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue