improve code documentation and remove dead code #2485
Conversation
This file contains hidden or 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
rdmark
changed the title
rdmark
force-pushed
the
2472-code-documentation-that-isnt-doxygen-compliant
branch
2 times, most recently
from
5ad6c5f to
09ae762
Compare
Touch up all code documentation structure warnings thrown by doxygen, while correcting typos and grammar Remove parameters and entire functions that are unused, rather than fixing the code documentation
Now since the code documentation is clean and compliant, let's treat warnings as errors in doxygen However, do this only when enabling -Dwith-doxygen-strict=true
rdmark
force-pushed
the
2472-code-documentation-that-isnt-doxygen-compliant
branch
2 times, most recently
from
f6a4d88 to
b0d4c22
Compare
rdmark
force-pushed
the
2472-code-documentation-that-isnt-doxygen-compliant
branch
from
b0d4c22 to
7a60a97
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Touch up all code documentation syntax warnings thrown by doxygen, while correcting typos and grammar
Remove parameters and entire functions that are unused, rather than fixing the code documentation for dead code
Now since the code documentation is clean and compliant, let's treat warnings as errors in doxygen
Introducing new meson option
-Dwith-doxygen-strict=truewhich enables error-on-warning behavior in doxygen; the reason for making this opt-in, is because doxygen will treat any unknown Doxyfile option as a warning=>error, so if you use anything but the very latest doxygen 1.14 you get a ton of errors (because doxygen apparently keeps adding new options all the time)Finally, build doxygen docs in a new job in the Tests workflow so that we can get an early warning when invalid code documentation gets introduced