Browse Source

Document return value of config_mgr_add_format().

Nick Mathewson 6 years ago
parent
commit
39316da9b6
1 changed files with 3 additions and 0 deletions
  1. 3 0
      src/app/config/confparse.c

+ 3 - 0
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,