Browse Source

Document warn_deprecated_option().

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

+ 4 - 0
src/app/config/confparse.c

@@ -578,6 +578,10 @@ config_mark_lists_fragile(const config_mgr_t *mgr, void *options)
   } SMARTLIST_FOREACH_END(mv);
 }
 
+/**
+ * Log a warning that declaring that the option called <b>what</b>
+ * is deprecated because of the reason in <b>why</b>.
+ **/
 void
 warn_deprecated_option(const char *what, const char *why)
 {