patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

doc: doxygen: Hide implementation detail symbols

Browse source 
Hide all symbols whose names begin with an underscore.  Although these
might be documented, they shouldn't be used by applications, as there's
no guarantee they will be available in subsequent versions, or maintain
API and ABI compatibility.

Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
This commit is contained in:
Leandro Pereira 2018-02-20 09:32:39 -08:00 committed by Anas Nashif
parent 3beb481bab
commit 44be8fbb30
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/zephyr.doxyfile
View file

@ -830,7 +830,9 @@ EXCLUDE_PATTERNS =
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
# Hide internal names (starting with an underscore, and doxygen-generated names
# for nested unnamed unions that don't generate meaningful sphinx output anyway.
EXCLUDE_SYMBOLS = _*, *.__unnamed__
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include