Add a property to Squiz.Commenting.FunctionComment to skip processing for {@inheritdoc} (issue #2770) #3051
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
…nheritdoc} (and nothing else).
gsherwood
added a commit
that referenced
this pull request
Jan 19, 2021
gsherwood
added a commit
that referenced
this pull request
Jan 19, 2021
|
Thanks a lot for this new sniff property. This will be released in 3.6.0 and is documented here: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties#squizcommentingfunctioncomment |
PavelSavushkinMix
added a commit
to PavelSavushkinMix/PHP_CodeSniffer
that referenced
this pull request
Jan 17, 2022
It's supported to use {@inheritdoc}. Add a support of @inheritdoc (w/ brackets). Original PR number - squizlabs#3051 Closes squizlabs#2770
PavelSavushkinMix
added a commit
to PavelSavushkinMix/PHP_CodeSniffer
that referenced
this pull request
Jan 17, 2022
It's supported to use {@inheritdoc}. Add support of @inheritdoc (w/o brackets). Original PR number - squizlabs#3051 Closes squizlabs#2770
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.
#2770 and numerous previous closed issues have requested supporting
{@inheritdoc}for function comments. This PR adds an optional property to the sniff that skips erroring on missing@param,@return, or@throwsif the whole contents of the docblock are exactly{@inheritdoc}(case-insensitive).Example usage: