diff options
| author | Nick Mathewson <nickm@torproject.org> | 2019-11-05 12:24:02 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2019-11-05 12:24:02 -0500 |
| commit | d3e547b2bd93a5e43e90bda144971e243e092a57 (patch) | |
| tree | 56b879f39c8ac1d46246c2d9bd74f854a5aab42a /Doxyfile.in | |
| parent | 884056ae57fb1dd80b39c9e503306c02732a551d (diff) | |
| download | tor-d3e547b2bd93a5e43e90bda144971e243e092a57.tar.gz tor-d3e547b2bd93a5e43e90bda144971e243e092a57.zip | |
Re-think our doxygen warnings wrt missing docs and fatalness.
Up till now, we have warned about all missing documentation, which
meant that we could never make doxygen warnings fatal. This has led
to our doxygen output getting full of errors several times in the
past.
This commit changes our approach to doxygen warnings: missing
documentation warnings are only on when the user asks for them with
--enable-missing-doc-warnings. When that option is not present,
doxygen respects the --enable-fatal-warnings flag.
Closes ticket 32385.
Diffstat (limited to 'Doxyfile.in')
| -rw-r--r-- | Doxyfile.in | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doxyfile.in b/Doxyfile.in index be500bbfa8..0f8b111d98 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -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 |