bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: doxygen: use STRIP_FROM_INC_PATH to keep #includes clean

Browse Source 
Another take on zephyrproject-rtos/zephyr#76953.
This uses STRIP_FROM_INC_PATH to make sure #include snippets in the
documentation are not absolute paths and reflect what one would
actually use in their code.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2025-07-09 17:58:33 +02:00 committed by Daniel DeGrasse
parent fb9783d880
commit ee173abeb3
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/zephyr.doxyfile.in
View File

@ -189,7 +189,17 @@ STRIP_FROM_PATH = @ZEPHYR_BASE@/include
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# TODO: Once https://github.com/doxygen/doxygen/pull/11657 is accepted and
# available in a released Doxygen version, the entry
# "@ZEPHYR_BASE@/lib/libc/minimal/include/" should be added to this list.
# In the meantime, API from headers contained in this folder (e.g. errno.h) will
# continue to show incorrect include path in the generated docs.
STRIP_FROM_INC_PATH = @ZEPHYR_BASE@/include/ \
@ZEPHYR_BASE@/kernel/include/ \
@ZEPHYR_BASE@/subsys/testsuite/include/ \
@ZEPHYR_BASE@/subsys/secure_storage/include/internal \
@ZEPHYR_BASE@/subsys/secure_storage/include
# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
@ -996,6 +1006,10 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
# Note that when adding paths to INPUT you most likely want to add them
# to STRIP_FROM_INC_PATH as well, which will remove those parts from
# the paths of the #include examples in the generated documentation.
INPUT = @ZEPHYR_BASE@/doc/_doxygen/mainpage.md \
@ZEPHYR_BASE@/doc/_doxygen/groups.dox \
@ZEPHYR_BASE@/kernel/include/kernel_arch_interface.h \