Browse Source

doc: mm: fix heap function references in documentation

Add missing doxygengroup Low Level Heap Allocator and Multi-Heap Wrapper
Utility.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
pull/74950/head
Johann Fischer 1 year ago committed by Anas Nashif
parent
commit
90081578ae
  1. 4
      doc/kernel/memory_management/heap.rst
  2. 10
      include/zephyr/sys/multi_heap.h
  3. 9
      include/zephyr/sys/sys_heap.h

4
doc/kernel/memory_management/heap.rst

@ -231,6 +231,10 @@ API Reference @@ -231,6 +231,10 @@ API Reference
.. doxygengroup:: heap_apis
.. doxygengroup:: low_level_heap_allocator
.. doxygengroup:: multi_heap_wrapper
Heap listener
*************

10
include/zephyr/sys/multi_heap.h

@ -9,6 +9,12 @@ @@ -9,6 +9,12 @@
#define MAX_MULTI_HEAPS 8
/**
* @defgroup multi_heap_wrapper Multi-Heap Wrapper
* @ingroup heaps
* @{
*/
/**
* @brief Multi-heap allocator
*
@ -162,4 +168,8 @@ const struct sys_multi_heap_rec *sys_multi_heap_get_heap(const struct sys_multi_ @@ -162,4 +168,8 @@ const struct sys_multi_heap_rec *sys_multi_heap_get_heap(const struct sys_multi_
*/
void sys_multi_heap_free(struct sys_multi_heap *mheap, void *block);
/**
* @}
*/
#endif /* ZEPHYR_INCLUDE_SYS_MULTI_HEAP_H_ */

9
include/zephyr/sys/sys_heap.h

@ -66,6 +66,12 @@ struct z_heap_stress_result { @@ -66,6 +66,12 @@ struct z_heap_stress_result {
uint64_t accumulated_in_use_bytes;
};
/**
* @defgroup low_level_heap_allocator Low Level Heap Allocator
* @ingroup heaps
* @{
*/
#ifdef CONFIG_SYS_HEAP_RUNTIME_STATS
/**
@ -252,6 +258,9 @@ void sys_heap_stress(void *(*alloc_fn)(void *arg, size_t bytes), @@ -252,6 +258,9 @@ void sys_heap_stress(void *(*alloc_fn)(void *arg, size_t bytes),
*/
void sys_heap_print_info(struct sys_heap *heap, bool dump_chunks);
/**
* @}
*/
#ifdef __cplusplus
}

Loading…
Cancel
Save