Skip to content

Commit bd3c76c

Browse files
dcpleungnashif
authored andcommitted
doc: force include interface header files first
Force include interface header files first before other files under include. This is due to doxygen always using the first found item during linking. Because of this, without forcing the interface definitions first, almost all of these would link to the same named items, for example, under ARC header files instead. Hence the need to manually shuffle the items so linking would actually link to the correct items. Note that this only works with functions and macros that are actually defined in the interface file. A simple doc section with @def would not work as this is not an actual definition. Signed-off-by: Daniel Leung <[email protected]>
1 parent 94291a0 commit bd3c76c

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/zephyr.doxyfile.in

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -924,6 +924,9 @@ WARN_LOGFILE =
924924
INPUT = @ZEPHYR_BASE@/doc/_doxygen/mainpage.md \
925925
@ZEPHYR_BASE@/doc/_doxygen/groups.dox \
926926
@ZEPHYR_BASE@/kernel/include/kernel_arch_interface.h \
927+
@ZEPHYR_BASE@/include/zephyr/arch/cache.h \
928+
@ZEPHYR_BASE@/include/zephyr/sys/arch_interface.h \
929+
@ZEPHYR_BASE@/include/zephyr/sys/atomic.h \
927930
@ZEPHYR_BASE@/include/ \
928931
@ZEPHYR_BASE@/lib/libc/minimal/include/ \
929932
@ZEPHYR_BASE@/subsys/testsuite/include/ \

0 commit comments

Comments
 (0)