[tor-commits] [tor/master] Documentation cleanup in confmacros.h

nickm at torproject.org nickm at torproject.org
Mon Oct 28 11:31:50 UTC 2019


commit f751cc020f2ccfa165ad5ef2a1dca11a36b56593
Author: Nick Mathewson <nickm at torproject.org>
Date:   Sat Oct 26 17:21:18 2019 -0400

    Documentation cleanup in confmacros.h
---
 src/lib/conf/confmacros.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/lib/conf/confmacros.h b/src/lib/conf/confmacros.h
index 67082454a..10de1fbce 100644
--- a/src/lib/conf/confmacros.h
+++ b/src/lib/conf/confmacros.h
@@ -45,7 +45,7 @@
   }
 
 /**
- * As CONFIG_VAR_XTYPE, but declares a value using an extension type whose
+ * As CONFIG_VAR_ETYPE, but declares a value using an extension type whose
  * type definition is <b>vartype</b>_type_defn.
  **/
 #define CONFIG_VAR_DEFN(structtype, varname, vartype, membername,       \
@@ -61,6 +61,9 @@
     CONF_TEST_MEMBERS(structtype, vartype, membername)                  \
   }
 
+/**
+ * Declare an obsolete configuration variable with a given name.
+ **/
 #define CONFIG_VAR_OBSOLETE(varname)            \
   { .member = { .name = varname, .type = CONFIG_TYPE_OBSOLETE },        \
     .flags = CFLG_GROUP_OBSOLETE                                        \





More information about the tor-commits mailing list