aboutsummaryrefslogtreecommitdiff
path: root/src/app/config/confparse.c
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-09-04 14:01:32 -0400
committerNick Mathewson <nickm@torproject.org>2019-09-04 14:23:19 -0400
commit39316da9b643583f52c1ff30bca7a07ea04cdba3 (patch)
treef99622aa60232bf901e1e96f7013bd8854636632 /src/app/config/confparse.c
parent39dd2e2aa826930bfe681d99c3e8374757ac511b (diff)
downloadtor-39316da9b643583f52c1ff30bca7a07ea04cdba3.tar.gz
tor-39316da9b643583f52c1ff30bca7a07ea04cdba3.zip
Document return value of config_mgr_add_format().
Diffstat (limited to 'src/app/config/confparse.c')
-rw-r--r--src/app/config/confparse.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c
index f20a361ba3..23a89ba627 100644
--- a/src/app/config/confparse.c
+++ b/src/app/config/confparse.c
@@ -203,6 +203,9 @@ config_mgr_register_fmt(config_mgr_t *mgr,
/**
* Add a new format to this configuration object. Asserts on failure.
*
+ * Returns an internal "index" value used to identify this format within
+ * all of those formats contained in <b>mgr</b>. This index value
+ * should not generally be used outside of this module.
**/
int
config_mgr_add_format(config_mgr_t *mgr,