Clarify that "missing-doc-warnings" makes doxygen warnings nonfatal

This commit is contained in:
Nick Mathewson 2019-11-06 16:59:41 -05:00
parent d3e547b2bd
commit b1083584c7
2 changed files with 3 additions and 2 deletions

View File

@ -2,4 +2,5 @@
- Our "make doxygen" target now respects --enable-fatal-warnings by
default, and does not warn about items that are missing documentation.
To warn about missing documentation, run configure with the
"--enable-missing-doc-warnings" flag. Closes ticket 32385.
"--enable-missing-doc-warnings" flag: doing so suspends fatal warnings
for doxygen. Closes ticket 32385.

View File

@ -77,7 +77,7 @@ AC_ARG_ENABLE(pic,
AS_HELP_STRING(--enable-pic, [Build Tor's binaries as position-independent code, suitable to link as a library.]))
AC_ARG_ENABLE(missing-doc-warnings,
AS_HELP_STRING(--enable-missing-doc-warnings, [Tell doxygen to warn about missing documentation.]))
AS_HELP_STRING(--enable-missing-doc-warnings, [Tell doxygen to warn about missing documentation. Makes doxygen warnings nonfatal.]))
if test "$enable_missing_doc_warnings" = "yes"; then
DOXYGEN_FATAL_WARNINGS=NO