Skip to content

Commit 0b20bc3

Browse files
author
John Nonweiler
committed
Add script to filter Doxygen warnings
Add a list of expected warnings from Doxygen, a Python script to filter out those warnings from the output from Doxygen, and a simple bash script to run doxygen using this filter. In some cases, it would be relatively easy to fix the Doxygen documentation so that we don't get these warnings. However, in other cases there are bugs in Doxygen where the code and documentation are perfectly valid, and Doxygen gives an erroneous warning message. Currently, CI uses another script to filter out warnings related to lines of code which have not been changed. However, this doesn't work well because the line number reported for a warning is often not the line where the problem lies. The new script should be useful for CI, and also for checking changes locally before running CI.
1 parent 75bec44 commit 0b20bc3

File tree

4 files changed

+311
-2
lines changed

4 files changed

+311
-2
lines changed

doc/architectural/compilation-and-development.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,10 @@ tools. All of these could be improved and patches are very welcome. In
194194
some cases the algorithms used are described in the relevant papers.
195195

196196
The doxygen documentation can be [accessed online](http://cprover.diffblue.com).
197-
To build it locally, run `doxygen` in `src/`. HTML output will be created in
198-
`doc/html/`. The index page is `doc/html/index.html`.
197+
To build it locally, run `scripts/run_doxygen.sh`. (This script will filter out
198+
expected warning messages from doxygen, so that new problems are more obvious.)
199+
HTML output will be created in `doc/html/`. The index page is
200+
`doc/html/index.html`.
199201

200202

201203
\section compilation-and-development-section-formatting Formatting

0 commit comments

Comments
 (0)