Skip to content

Commit 16ea79f

Browse files
committed
doc: fix doxygen comments in zephyr include headers
Fix parameter name mismatch in module_driver_heap_remove() and correct struct field documentation for vmh_block_bundle_descriptor and vmh_heap_config so Doxygen parses zephyr/include cleanly without warnings. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
1 parent 66fb0a9 commit 16ea79f

2 files changed

Lines changed: 3 additions & 13 deletions

File tree

‎zephyr/include/rtos/userspace_helper.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ int user_stack_free(void *p_stack);
9595

9696
/**
9797
* Free private processing module heap.
98-
* @param sys_heap pointer to the sys_heap structure.
98+
* @param mod_drv_heap pointer to the k_heap structure.
9999
*
100100
* @note
101101
* Function used only when CONFIG_USERSPACE is set.

‎zephyr/include/sof/lib/regions_mm.h‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,9 @@
4949
*/
5050
#define DEFAULT_CONFIG_ALOCATORS_COUNT 5
5151

52-
/** @struct vmh_block_bundle_descriptor
53-
*
54-
* @brief This is a struct describing one bundle of blocks
55-
* used as base for allocators blocks.
56-
*
57-
* @var block_size size of memory block.
58-
* @var number_of_blocks number of memory blocks.
59-
*/
6052
struct vmh_block_bundle_descriptor {
61-
size_t block_size;
62-
size_t number_of_blocks;
53+
size_t block_size; /**< size of memory block. */
54+
size_t number_of_blocks; /**< number of memory blocks. */
6355
};
6456

6557
/*
@@ -75,8 +67,6 @@ struct vmh_block_bundle_descriptor {
7567
* Provided config size must be physical page aligned so it
7668
* will not overlap in physical space with other heaps during mapping.
7769
* So every block has to have its overall size aligned to CONFIG_MM_DRV_PAGE_SIZE
78-
*
79-
* @vmh_block_bundle_descriptor[] aggregation of bundle descriptors.
8070
*/
8171
struct vmh_heap_config {
8272
struct vmh_block_bundle_descriptor block_bundles_table[MAX_MEMORY_ALLOCATORS_COUNT];

0 commit comments

Comments
 (0)