Treat doxygen warnings as errors #890
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
schaubh
added
documentation
schaubh
force-pushed
the
feature/doxygen_warning
branch
from
a46a3b4 to
6309079
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The RST documentation system uses doxygen to pull information from C/C++ files. However, if doxygen created warnings about missing variable or method definitions these warnings were not treated as errors. This is now corrected.
Verification
Did a test build of documentation where a variable definition was missing and the process error'd out immediately.
Documentation
Updated release notes.
Future work
Documentation related items are always work in progress.