Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Open
PavelSavushkinMix wants to merge 3 commits into squizlabs:master
base: master
Choose a base branch
Loading
from PavelSavushkinMix:fix/inherit_doc_without_brackets

Conversation

@PavelSavushkinMix
Copy link

@PavelSavushkinMix PavelSavushkinMix commented Jan 17, 2022

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

Closes #2770

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.

Copy link
Author

This PR is missing tests. Please add some.

Thanks for the fast reply.
Added tests.

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?

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

PavelSavushkinMix reacted with thumbs up emoji

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

/**
/**
Copy link
Author

@PavelSavushkinMix PavelSavushkinMix Jan 17, 2022

Choose a reason for hiding this comment

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

Suggested change
/**
/**

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jrfnl jrfnl jrfnl requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

AltStyle によって変換されたページ (->オリジナル) /