From: Nick Mathewson <nickm@torproject.org>
Date: Sat, 26 Oct 2019 21:21:18 +0000 (-0400)
Subject: Documentation cleanup in confmacros.h
X-Git-Tag: tor-0.4.3.1-alpha~239^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f751cc020f2ccfa165ad5ef2a1dca11a36b56593;p=thirdparty%2Ftor.git

Documentation cleanup in confmacros.h
---

diff --git a/src/lib/conf/confmacros.h b/src/lib/conf/confmacros.h
index 67082454a2..10de1fbcee 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                                        \