-
Notifications
You must be signed in to change notification settings - Fork 215
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.
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
Fix all Doxygen warnings #1040
Merged
Merged
Fix all Doxygen warnings #1040
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
@kring pointed out that the ideal here is that we get Doxygen warnings to zero, so we can then start treating them as errors which will help make sure we keep the docs up to date going forward. I think that's an achievable goal, so I'm making this PR a draft for the moment while I work on that. |
And with that, every remaining warning has been resolved! |
This is great, thanks @azrogers! |
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.
This PR fixes every remaining Doxygen warning, and configures Doxygen to return a non-zero exit code when there's a warning, meaning the CI task will fail if code is added that causes new warnings. This not only helps improve our current documentation, but will allow us to keep a better eye on our documentation going forward!
Original description: