[tor-commits] [tor/release-0.4.3] Doxygen: fix unbalanced groups.

[nickm@xxxxxxxxxxxxxx]

commit 68fe8826ddec2eefa103e4772bce35f7d1666ac3
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Tue May 19 09:18:39 2020 -0400

    Doxygen: fix unbalanced groups.
    
    Closes ticket 34255.
---
 changes/ticket34255_043        | 3 +++
 src/lib/conf/confdecl.h        | 6 +++---
 src/lib/container/smartlist.c  | 2 +-
 src/lib/string/compat_ctype.c  | 1 +
 src/lib/wallclock/time_to_tm.c | 1 +
 5 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/changes/ticket34255_043 b/changes/ticket34255_043
new file mode 100644
index 000000000..5cfec1d48
--- /dev/null
+++ b/changes/ticket34255_043
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Fix several doxygen warnings related to imbalanced groups.
+      Closes ticket 34255.
diff --git a/src/lib/conf/confdecl.h b/src/lib/conf/confdecl.h
index f7e79bb2b..c2d3fb335 100644
--- a/src/lib/conf/confdecl.h
+++ b/src/lib/conf/confdecl.h
@@ -136,11 +136,11 @@
   },
 /**@}*/
 
-/* @defgroup STUB_TABLE_MACROS Internal macros: stub table declarations,
+/** @defgroup STUB_TABLE_MACROS Internal macros: stub table declarations,
  * for use when a module is disabled.
  * Implementation helpers: the regular confdecl macros expand to these
  * when CONF_CONTEXT is defined to LL_TABLE.  Don't use them directly.
- * @{*/
+ * @{ */
 #define BEGIN_CONF_STRUCT__STUB_TABLE(structname)                       \
   static const config_var_t structname##_vars[] = {
 #define END_CONF_STRUCT__STUB_TABLE(structname)   \
@@ -166,7 +166,7 @@
  * when the macro sees us declare a configuration option "foo" of type STRING,
  * it can emit `config_decl_STRING foo;`, which is an alias for `char *foo`.
  */
-/**{*/
+/**@{*/
 typedef char *config_decl_STRING;
 typedef char *config_decl_FILENAME;
 /* Yes, "POSINT" is really an int, and not an unsigned int.  For
diff --git a/src/lib/container/smartlist.c b/src/lib/container/smartlist.c
index eeb3bce95..7784f8395 100644
--- a/src/lib/container/smartlist.c
+++ b/src/lib/container/smartlist.c
@@ -652,7 +652,7 @@ smartlist_sort_pointers(smartlist_t *sl)
 #define LEFT_CHILD(i)  ( 2*(i) + 1 )
 #define RIGHT_CHILD(i) ( 2*(i) + 2 )
 #define PARENT(i)      ( ((i)-1) / 2 )
-/** }@ */
+/** @} */
 
 /** @{ */
 /** Helper macros for heaps: Given a local variable <b>idx_field_offset</b>
diff --git a/src/lib/string/compat_ctype.c b/src/lib/string/compat_ctype.c
index 235760502..a7668bfbf 100644
--- a/src/lib/string/compat_ctype.c
+++ b/src/lib/string/compat_ctype.c
@@ -29,6 +29,7 @@ const uint32_t TOR_ISPRINT_TABLE[8] =
   { 0, 0xffffffff, 0xffffffff, 0x7fffffff, 0, 0, 0, 0x0 };
 const uint32_t TOR_ISUPPER_TABLE[8] = { 0, 0, 0x7fffffe, 0, 0, 0, 0, 0 };
 const uint32_t TOR_ISLOWER_TABLE[8] = { 0, 0, 0, 0x7fffffe, 0, 0, 0, 0 };
+/**@}*/
 
 /** Upper-casing and lowercasing tables to map characters to upper/lowercase
  * equivalents.  Used by tor_toupper() and tor_tolower(). */
diff --git a/src/lib/wallclock/time_to_tm.c b/src/lib/wallclock/time_to_tm.c
index dcd3c59c5..8c747b4c7 100644
--- a/src/lib/wallclock/time_to_tm.c
+++ b/src/lib/wallclock/time_to_tm.c
@@ -198,3 +198,4 @@ tor_gmtime_r_msg(const time_t *timep, struct tm *result, char **err_out)
   return correct_tm(0, timep, result, r, err_out);
 }
 #endif /* defined(HAVE_GMTIME_R) || ... */
+/**@}*/



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