소스 검색

Document warn_deprecated_option().

Nick Mathewson 6 년 전
부모
커밋
3db56aeeb8
1개의 변경된 파일4개의 추가작업 그리고 0개의 파일을 삭제
  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)
 {