aboutsummaryrefslogtreecommitdiff
path: root/src/app/config/confparse.h
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-08-29 09:14:51 -0400
committerNick Mathewson <nickm@torproject.org>2019-08-29 09:14:51 -0400
commitc281fa0da20ebb2cd6849b52ff45e114075fd88a (patch)
tree758652a035dcd91ace55b859bab805abead5c7ba /src/app/config/confparse.h
parentb1d7ddfb02cdbd23fce0c30d6ab4897ede18e7fe (diff)
downloadtor-c281fa0da20ebb2cd6849b52ff45e114075fd88a.tar.gz
tor-c281fa0da20ebb2cd6849b52ff45e114075fd88a.zip
Describe clear_cfg_fn_t better.
Diffstat (limited to 'src/app/config/confparse.h')
-rw-r--r--src/app/config/confparse.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h
index 0ff33f6edc..b788e2cd1b 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