zephyr/doc/guides
Peter Bigot 7410b9ed34 doc: guides: design: document how to handle conditional documentation
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>
2020-08-25 18:09:56 +02:00
..
bluetooth
build
coding_guidelines
crypto
debugging debug/coredump: add a primitive coredump mechanism 2020-08-24 20:28:24 -04:00
device_mgmt
documentation
dts doc: guides: dts: document expectation for devicetree driver configuration 2020-08-25 18:09:56 +02:00
kconfig
networking
optimizations
platformio
portability doc: guides: portability: fix misspellings in POSIX C LANG table 2020-08-21 13:55:32 -04:00
porting doc: guides: porting: shields: fix directory layout examples 2020-08-21 10:27:57 +02:00
test
tools
tracing
west
beyond-GSG.rst
c_library.rst
coccinelle.rst
code-relocation.rst
coverage.rst
design_guidelines.rst doc: guides: design: document how to handle conditional documentation 2020-08-25 18:09:56 +02:00
env_vars.rst
getting-help.rst
index.rst doc: guides: add design guidelines with callback expectations 2020-08-25 18:09:56 +02:00
modules.rst
zephyr_cmake_package.rst cmake: Zephyr CMake package clean-up and minor fix 2020-08-19 12:52:33 -04:00