feat: Check that doc comments match for function decl/defn. #68
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
auto-add-label
bot
added
the
enhancement
JFreegman
approved these changes
Dec 21, 2021
There was a problem hiding this comment.
Reviewed 10 of 10 files at r1, all commit messages.
Reviewable status:complete! 1 of 1 approvals obtained
This currently only works for Doxygen comments, i.e. ones starting with `/**`. This is because we can't distinguish between random comments in the middle of the file and function comments. Ultimately, we'll want all function comments to be doxygen style comments anyway.
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 currently only works for Doxygen comments, i.e. ones starting with
/**. This is because we can't distinguish between random comments inthe middle of the file and function comments. Ultimately, we'll want all
function comments to be doxygen style comments anyway.
This change is