Skip to content

Add script to filter Doxygen warnings #3250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2018
Merged

Add script to filter Doxygen warnings #3250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions doc/architectural/compilation-and-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading