[tor-commits] [tor/master] Doxygen: Better path handling.

nickm at torproject.org nickm at torproject.org
Mon Nov 4 13:39:42 UTC 2019


commit e2da29e045348d59dea80246b4026cd1841d7461
Author: Nick Mathewson <nickm at torproject.org>
Date:   Sun Nov 3 15:00:14 2019 -0500

    Doxygen: Better path handling.
    
    This change tells doxygen to include all files not explicitly
    excluded, and to document paths along with filenames.
---
 Doxyfile.in | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/Doxyfile.in b/Doxyfile.in
index b69f95eba..0128f1281 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -161,7 +161,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = NO
+FULL_PATH_NAMES        = YES
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -173,7 +173,7 @@ FULL_PATH_NAMES        = NO
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        =
+STRIP_FROM_PATH        = @top_srcdir@/src
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -816,10 +816,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @top_srcdir@/src/lib \
-                         @top_srcdir@/src/core \
-                         @top_srcdir@/src/feature \
-                         @top_srcdir@/src/app
+INPUT                  = @top_srcdir@/src/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -861,7 +858,9 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = @top_srcdir@/src/ext \
+                         @top_srcdir@/src/trunnel \
+                         @top_srcdir@/src/test
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded





More information about the tor-commits mailing list