From 44be8fbb309849c4420ffff4e09d15e10f070ec7 Mon Sep 17 00:00:00 2001 From: Leandro Pereira Date: Tue, 20 Feb 2018 09:32:39 -0800 Subject: [PATCH] doc: doxygen: Hide implementation detail symbols 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 --- doc/zephyr.doxyfile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/zephyr.doxyfile b/doc/zephyr.doxyfile index 0349f8ef3c..63e536267f 100644 --- a/doc/zephyr.doxyfile +++ b/doc/zephyr.doxyfile @@ -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