torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Re-think our doxygen warnings wrt missing docs and fatalness.

Browse Source 
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.
This commit is contained in:
Nick Mathewson
2019-11-05 12:24:02 -05:00
parent 884056ae57
commit d3e547b2bd
3 changed files with 25 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changes/ticket32385
+5
View File
@@ -0,0 +1,5 @@
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. Closes ticket 32385.