mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-27 13:53:31 +01:00
Merge branch 'ticket32385'
This commit is contained in:
commit
2b3dc3384c
@ -767,7 +767,7 @@ WARNINGS = YES
|
||||
# will automatically be disabled.
|
||||
# The default value is: YES.
|
||||
|
||||
WARN_IF_UNDOCUMENTED = YES
|
||||
WARN_IF_UNDOCUMENTED = @DOXYGEN_WARN_ON_MISSING@
|
||||
|
||||
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
|
||||
# potential errors in the documentation, such as not documenting some parameters
|
||||
@ -790,7 +790,7 @@ WARN_NO_PARAMDOC = NO
|
||||
# a warning is encountered.
|
||||
# The default value is: NO.
|
||||
|
||||
WARN_AS_ERROR = NO
|
||||
WARN_AS_ERROR = @DOXYGEN_FATAL_WARNINGS@
|
||||
|
||||
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
|
||||
# can produce. The string should contain the $file, $line, and $text tags, which
|
||||
|
6
changes/ticket32385
Normal file
6
changes/ticket32385
Normal file
@ -0,0 +1,6 @@
|
||||
o Minor features (doxygen):
|
||||
- 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: doing so suspends fatal warnings
|
||||
for doxygen. Closes ticket 32385.
|
18
configure.ac
18
configure.ac
@ -81,6 +81,24 @@ AC_ARG_ENABLE(nss,
|
||||
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. Makes doxygen warnings nonfatal.]))
|
||||
|
||||
if test "$enable_missing_doc_warnings" = "yes"; then
|
||||
DOXYGEN_FATAL_WARNINGS=NO
|
||||
DOXYGEN_WARN_ON_MISSING=YES
|
||||
elif test "$enable_fatal_warnings" = "yes"; then
|
||||
# Fatal warnings from doxygen are nice, but not if we're warning about
|
||||
# missing documentation.
|
||||
DOXYGEN_FATAL_WARNINGS=YES
|
||||
DOXYGEN_WARN_ON_MISSING=NO
|
||||
else
|
||||
DOXYGEN_FATAL_WARNINGS=NO
|
||||
DOXYGEN_WARN_ON_MISSING=NO
|
||||
fi
|
||||
AC_SUBST(DOXYGEN_FATAL_WARNINGS)
|
||||
AC_SUBST(DOXYGEN_WARN_ON_MISSING)
|
||||
|
||||
if test "x$enable_coverage" != "xyes" -a "x$enable_asserts_in_tests" = "xno" ; then
|
||||
AC_MSG_ERROR([Can't disable assertions outside of coverage build])
|
||||
fi
|
||||
|
Loading…
Reference in New Issue
Block a user