tor

commit 39316da9b643583f52c1ff30bca7a07ea04cdba3
parent 39dd2e2aa826930bfe681d99c3e8374757ac511b
Author: Nick Mathewson <nickm@torproject.org>
Date:   Wed,  4 Sep 2019 14:01:32 -0400

Document return value of config_mgr_add_format().

Diffstat:
M
src/app/config/confparse.c
 | 
3
+++

1 file changed, 3 insertions(+), 0 deletions(-)
diff --git 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,