Skip to content
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.

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

Generated device driver docs #30104

Closed
Prev Previous commit
Next Next commit
doc: add drivers subdirectories to doxygen
This pulls various driver source files into the documentation build
system's awareness, making their doxygen comments available to Breathe
and other scripts.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
mbolivar-nordic committed Nov 18, 2020
commit 799644a5db352f5239c03638acfe735ed2cba700
1 change: 1 addition & 0 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -148,6 +148,7 @@ file(GLOB_RECURSE DOXY_SOURCES
${ZEPHYR_BASE}/lib/libc/*.[c,h,S]
${ZEPHYR_BASE}/subsys/testsuite/ztest/include/*.[h,c,S]
${ZEPHYR_BASE}/tests/*.[h,c,S]
${ZEPHYR_BASE}/drivers/*.[c,h,S]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This worries me a little: until now headers that were private to a driver subsystem would never be accessed outside that subsystem, so there was little concern about ensuring public identifiers are globally unique.

Now MISRA apparently wants every identifier anywhere in the program to be unique, though that's not really feasible, and maybe this isn't going to bite us too bad, but it leaves me nervous.

)
# For debug. Also find generated list in doc/_build/(build.ninja|CMakeFiles/)
# message("DOXY_SOURCES= " ${DOXY_SOURCES})
3 changes: 2 additions & 1 deletion doc/zephyr.doxyfile.in
Original file line number Diff line number Diff line change
@@ -751,7 +751,8 @@ INPUT = custom-doxygen/mainpage.md \
@ZEPHYR_BASE@/include/ \
@ZEPHYR_BASE@/lib/libc/minimal/include/ \
@ZEPHYR_BASE@/subsys/testsuite/ztest/include/ \
@ZEPHYR_BASE@/tests/kernel/
@ZEPHYR_BASE@/tests/kernel/ \
@ZEPHYR_BASE@/drivers/

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses