Add documentation check with doxygen #30
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
8 tasks
Signed-off-by: Louise Poubel <[email protected]>
chapulina
force-pushed
the
chapulina/doxygen
branch
from
10f3465 to
17db640
Compare
Signed-off-by: Louise Poubel <[email protected]>
Signed-off-by: Louise Poubel <[email protected]>
8 tasks
ahcorde
approved these changes
Aug 19, 2021
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.
I noticed today that our
make doctarget has doxygen warnings enabled, and thatign-cmakehas a convenient script that can output the warnings and fail the build if so.So I'm opening this to start the process of enabling this check for all CI. Before merging, we should go through all libraries and fix the existing warnings first, so we don't just break the build. Leaving this as draft until we do.Made it optional so we can implement it incrementally.