Merge pull request #3250 from johnnonweiler/doxygen-warnings-filter

Add script to filter Doxygen warnings

Author: chrisr-diffblue

doc/architectural/compilation-and-development.md

@@ -194,8 +194,14 @@ tools. All of these could be improved and patches are very welcome. In
 some cases the algorithms used are described in the relevant papers.
 
 The doxygen documentation can be [accessed online](http://cprover.diffblue.com).
-To build it locally, run `doxygen` in `src/`. HTML output will be created in
-`doc/html/`. The index page is `doc/html/index.html`.
+To build it locally, run `scripts/run_doxygen.sh`.  HTML output will be created
+in `doc/html/`. The index page is `doc/html/index.html`.  This script will
+filter out expected warning messages from doxygen, so that new problems are more
+obvious.  In the event that any change fixes an old warning, then the
+corresponding line(s) should be deleted from
+`scripts/expected_doxygen_warnings.txt`.  We want to avoid adding any more
+warnings to this list of expected warnings, but that can be done to work around
+limitations in Doxygen (where the code and documentation are completely correct).
 
 
 \section compilation-and-development-section-formatting Formatting