[tor-commits] [tor/master] Describe clear_cfg_fn_t better.

[dgoulet at torproject.org]

commit c281fa0da20ebb2cd6849b52ff45e114075fd88a
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Aug 29 09:14:51 2019 -0400

    Describe clear_cfg_fn_t better.
---
 src/app/config/confparse.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h
index 0ff33f6ed..b788e2cd1 100644
--- a/src/app/config/confparse.h
+++ b/src/app/config/confparse.h
@@ -44,11 +44,14 @@ struct config_mgr_t;
 /**
  * Callback to clear all non-managed fields of a configuration object.
  *
+ * <b>obj</b> is the configuration object whose non-managed fields should be
+ * cleared.
+ *
  * (Regular fields get cleared by config_reset(), but you might have fields
  * in the object that do not correspond to configuration variables.  If those
  * fields need to be cleared or freed, this is where to do it.)
  */
-typedef void (*clear_cfg_fn_t)(const struct config_mgr_t *mgr, void*);
+typedef void (*clear_cfg_fn_t)(const struct config_mgr_t *mgr, void *obj);
 
 /** Information on the keys, value types, key-to-struct-member mappings,
  * variable descriptions, validation functions, and abbreviations for a