buildsystem: Enable -Wdocumentation for LLVM #21358
Merged
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
This enables warnings for incorrect Doxygen comments when build with LLVM. To my experience, LLVM provides a low false positive rate (e.g. it does not complain about undocumented internal macros) and has very helpful output. This disable `-Wdocumentation-deprecated-sync` for now, as we do not deprecate code with attributes yet. The warnings are not set as errors, so that we can enable this without breaking builds.
|
Here the output can be seen on the samr21-xpro build with LLVM: https://ci.riot-os.org/details/abc2ab824d08411fab5d87e020e09f4f/builds/bootloaders:riotboot_serial |
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.
Contribution description
This enables warnings for incorrect Doxygen comments when build with LLVM. To my experience, LLVM provides a low false positive rate (e.g. it does not complain about undocumented internal macros) and has very helpful output.
This disable
-Wdocumentation-deprecated-syncfor now, as we do not deprecate code with attributes yet.The warnings are not set as errors, so that we can enable this without breaking builds.
Testing procedure
Should now warn about broken doc
Issues/PRs references
None