mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-02 23:41:56 +00:00
Various API involves functions and data that are conditionally enabled. Zephyr practice is to exclude data (always) and function (sometimes) declarations at build time using the enabling preprocessor macro. This meets functional needs, but blocks generation of the API documentation as Doxygen will not see the declarations. Document the need to extend Doxygen's PREDEFINED setting to generate the documentation. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no> |
||
---|---|---|
.. | ||
bluetooth | ||
build | ||
coding_guidelines | ||
crypto | ||
debugging | ||
device_mgmt | ||
documentation | ||
dts | ||
kconfig | ||
networking | ||
optimizations | ||
platformio | ||
portability | ||
porting | ||
test | ||
tools | ||
tracing | ||
west | ||
beyond-GSG.rst | ||
c_library.rst | ||
coccinelle.rst | ||
code-relocation.rst | ||
coverage.rst | ||
design_guidelines.rst | ||
env_vars.rst | ||
getting-help.rst | ||
index.rst | ||
modules.rst | ||
zephyr_cmake_package.rst |