Skip to content

doc: Add zephyr/include to the Doxygen input #10971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lgirdwood wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −14
Open

doc: Add zephyr/include to the Doxygen input #10971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28d6041
doc: Add zephyr/include to the Doxygen input
lrgirdwo Jun 11, 2026
8ce57b5
doc: fix doxygen comments in zephyr include headers
lrgirdwo Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/sof.doxygen.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ INPUT = @top_srcdir@/src/include/ipc \
@top_srcdir@/src/include/kernel \
@top_srcdir@/src/include/user \
@top_srcdir@/src/include/sof \
@top_srcdir@/xtos/include
@top_srcdir@/xtos/include \
@top_srcdir@/zephyr/include
# Exlude some 3rd party codec headers with external references
EXCLUDE = @top_srcdir@/src/include/sof/audio/MaxxEffect
RECURSIVE = YES
Expand Down
2 changes: 1 addition & 1 deletion zephyr/include/rtos/userspace_helper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ int user_stack_free(void *p_stack);

/**
* Free private processing module heap.
* @param sys_heap pointer to the sys_heap structure.
* @param mod_drv_heap pointer to the k_heap structure.
*
* @note
* Function used only when CONFIG_USERSPACE is set.
Expand Down
14 changes: 2 additions & 12 deletions zephyr/include/sof/lib/regions_mm.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,9 @@
*/
#define DEFAULT_CONFIG_ALOCATORS_COUNT 5

/** @struct vmh_block_bundle_descriptor
*
* @brief This is a struct describing one bundle of blocks
* used as base for allocators blocks.
*
* @var block_size size of memory block.
* @var number_of_blocks number of memory blocks.
*/
struct vmh_block_bundle_descriptor {
size_t block_size;
size_t number_of_blocks;
size_t block_size; /**< size of memory block. */
size_t number_of_blocks; /**< number of memory blocks. */
};

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