[tor-commits] [tor/master] Document return value of config_mgr_add_format().

[asn@xxxxxxxxxxxxxx]

commit 39316da9b643583f52c1ff30bca7a07ea04cdba3
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Wed Sep 4 14:01:32 2019 -0400

    Document return value of config_mgr_add_format().
---
 src/app/config/confparse.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c
index f20a361ba..23a89ba62 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,



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits