From 36bceacdcdc6e7ed666cb4bbbf8cc76132f89bbd Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Tue, 5 Nov 2019 12:42:49 -0500 Subject: [PATCH 1/2] 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 be500bbfa8..d0ff030ae0 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 From de4ffebcf0a8dc281c603ef871af392b8324dc30 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Tue, 5 Nov 2019 12:43:38 -0500 Subject: [PATCH 2/2] Doxygen: set HIDE_SCOPE_NAMES. This option tells doxygen to describe a member "member" of a struct "container" as "member", not "container::member". C doesn't use the :: syntax, so this should help us with readability. --- Doxyfile.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doxyfile.in b/Doxyfile.in index d0ff030ae0..2e1a6d0c23 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -558,7 +558,7 @@ CASE_SENSE_NAMES = YES # scope will be hidden. # The default value is: NO. -HIDE_SCOPE_NAMES = NO +HIDE_SCOPE_NAMES = YES # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to