[tor-commits] [tor/master] Clarify that "missing-doc-warnings" makes doxygen warnings nonfatal

[nickm at torproject.org]

commit b1083584c752398056a591fb9b342f4e58e6b172
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Nov 6 16:59:41 2019 -0500

    Clarify that "missing-doc-warnings" makes doxygen warnings nonfatal
---
 changes/ticket32385 | 3 ++-
 configure.ac        | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/changes/ticket32385 b/changes/ticket32385
index 2a4fc64f3..2ff76be26 100644
--- a/changes/ticket32385
+++ b/changes/ticket32385
@@ -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.
diff --git a/configure.ac b/configure.ac
index f3c955ad0..e8441411d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -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