[tor-commits] [tor/master] Teach doxygen about option-declaration code.

[nickm@xxxxxxxxxxxxxx]

commit 5914addcbc5da7ce2ae4e705090ccefd71f27007
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Sat Oct 26 20:21:02 2019 -0400

    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.
---
 Doxyfile.in | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/Doxyfile.in b/Doxyfile.in
index 2e1a6d0c2..a087012c7 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -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



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits