Teach doxygen about option-declaration code.

These settings allow doxygen to find and understand doxygen comments
in configuration definitions made using the macros in confdecl.h.
This commit is contained in:
Nick Mathewson 2019-10-26 20:21:02 -04:00
parent 1d108894e7
commit 5914addcbc

View File

@ -318,7 +318,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.
EXTENSION_MAPPING = dox=C h=C c=C
EXTENSION_MAPPING = dox=C h=C c=C inc=C
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
@ -845,7 +845,8 @@ INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.h \
*.dox
*.dox \
*.inc
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
@ -2110,7 +2111,10 @@ INCLUDE_FILE_PATTERNS =
PREDEFINED = "MOCK_IMPL(a,b,c)=a b c" \
"MOCK_DECL(a,b,c)=a b c" \
__attribute__(x)=
__attribute__(x)= \
"BEGIN_CONF_STRUCT(x)=struct x {" \
"END_CONF_STRUCT(x)=};" \
"CONF_VAR(a,b,c,d)=b a;"
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this