Commit b1083584 authored by Nick Mathewson's avatar Nick Mathewson 👁
Browse files

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

parent d3e547b2
......@@ -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.
......@@ -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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment