]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Doxygen: set TYPEDEF_HIDES_STRUCT.
authorNick Mathewson <nickm@torproject.org>
Tue, 5 Nov 2019 17:42:49 +0000 (12:42 -0500)
committerNick Mathewson <nickm@torproject.org>
Tue, 5 Nov 2019 17:43:21 +0000 (12:43 -0500)
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

index be500bbfa8111a7c0bd2b206498aa8e278fe5480..d0ff030ae08635b95079c54430ae7127727d445c 100644 (file)
@@ -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