-
Notifications
You must be signed in to change notification settings - Fork 1.5k
fix: skip processing of Squiz.Commenting.FunctionComment for @inheritDoc #3533
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: skip processing of Squiz.Commenting.FunctionComment for @inheritDoc #3533
Conversation
It's supported to use {@inheritdoc}. Add support of @inheritdoc (w/o brackets). Original PR number - squizlabs#3051 Closes squizlabs#2770
jrfnl
commented
Jan 17, 2022
For context:
phpDocumentor states that inheritance is implicit when there is no docblock, so the tag should only be used for partial inheritance via an inline tag {@inheritDoc}
Refs:
- https://docs.phpdoc.org/3.0/guide/guides/inheritance.html
- https://docs.phpdoc.org/3.0/guide/references/phpdoc/inline-tags/index.html#inline-tag-reference
The draft PSR-19 reference does allow for the tag without brackets, but then again, is still subject to change as still in draft.
Refs:
@jrfnl
jrfnl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is missing tests. Please add some.
PavelSavushkinMix
commented
Jan 17, 2022
This PR is missing tests. Please add some.
Thanks for the fast reply.
Added tests.
PavelSavushkinMix
commented
Jan 17, 2022
So, @jrfnl, would you like me to close the PR due to provided references?
Or just keep it till the PSR-19 is released?
jrfnl
commented
Jan 17, 2022
So, @jrfnl, would you like me to close the PR due to provided references?
Or just keep it till the PSR-19 is released?
Not really up to me. I added the references so the maintainer can make an informed decision.
I'd say, leave it open for now and wait for a response from someone with commit rights.
Be aware that it may be a while before you will get such a response.,
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's supported to use {@inheritdoc}. Add support of @inheritdoc (w/o brackets).
Original PR number - #3051
Closes #2770