Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix: skip processing of Squiz.Commenting.FunctionComment for @inheritDoc #3533

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

PavelSavushkinMix
Copy link

It's supported to use {@inheritdoc}. Add support of @inheritdoc (w/o brackets).
Original PR number - #3051

Closes #2770



It's supported to use {@inheritdoc}. Add support of @inheritdoc (w/o brackets).
Original PR number - squizlabs#3051

Closes squizlabs#2770
@jrfnl
Copy link
Contributor

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:

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:

Copy link
Contributor

@jrfnl jrfnl left a 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
Copy link
Author

This PR is missing tests. Please add some.

Thanks for the fast reply.
Added tests.

@PavelSavushkinMix
Copy link
Author

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
Copy link
Contributor

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.,

@@ -1042,7 +1052,7 @@ public function ignored() {

// phpcs:set Squiz.Commenting.FunctionComment specialMethods[] __construct,__destruct

/**
/**
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/**
/**

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Squiz.Commenting.FunctionComment.MissingReturn @inheritDoc not resolved?
2 participants