[tor-commits] [tor/master] Doxygen: set TYPEDEF_HIDES_STRUCT.

[nickm@xxxxxxxxxxxxxx]

commit 36bceacdcdc6e7ed666cb4bbbf8cc76132f89bbd
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Tue Nov 5 12:42:49 2019 -0500

    Doxygen: set TYPEDEF_HIDES_STRUCT.
    
    This option tells doxygen to handle typedef struct foo_t foo_t by
    making foo_t and struct foo_t synonymous. This lets doxygen find
    documentation that it would otherwise miss: otherwise, if it sees
    documentation for "int func(foo_t *)" and a prototype for
    "int func(struct foo_t)", it will think that the prototype is
    undocumented.
    
    Part of #32386.
---
 Doxyfile.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Doxyfile.in b/Doxyfile.in
index be500bbfa..d0ff030ae 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -435,7 +435,7 @@ INLINE_SIMPLE_STRUCTS  = NO
 # types are typedef'ed and only the typedef is referenced, never the tag name.
 # The default value is: NO.
 
-TYPEDEF_HIDES_STRUCT   = NO
+TYPEDEF_HIDES_STRUCT   = YES
 
 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
 # cache is used to resolve symbols given their name and scope. Since this can be



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