Report `@inheritDoc` when there is no PHPDoc to inherit from by kubawerlos · Pull Request #5583 · phpstan/phpstan-src · GitHub

Closes phpstan/phpstan#5561

I think we should distinguish two different case

inheritDoc is over a method which overrides nothing ; https://phpstan.org/r/f0c06876-6c7b-428b-8e61-562ac5abf7d7
inheritDoc is over a method which overrides method without phpdoc

The correct way to find parent methods is ParentMethodHelper.

@VincentLanglet do you mean as separate rules?

Not a class, but an error identifier for sure.

Hi @kubawerlos could you rebase and solve the conflict ?

Can't we do better ?

I know it'll be an edge case but you won't catch description like

/**
 * Please do not add `{@inheritDoc}` to this method
 */

Like this?

I'm not very good in regex but looking at the test called InheritDocInsideBackticks i'm not sure we understood each other.

My point was that, we might not want to consider that a method with

/**
 * Foo @inheritDoc
 */

has an inheritDoc, cause it might be just a comment.
It wasn't related to backticks

(On the opposite,

/**
 * @inheritDoc Bar
 */

might be considered as an inherit doc with an extra comment... ; I dunno)

I never use inheritDoc so I can't stay what we can find in codebase.

Updated test.

@inheritDoc Bar will be tokenised as a tag with extra description.

can this regex be simplified because it uses i modifier (case-less), so the pattern itself does not need to handle both upper and lower case things?

What do you mean? To lowercase $child->text and drop i, or to match only on exact case match?

I mean a-zA-Z does not make sense in a i modfied regex

but as commented in the other stream.. I am not convinced this regex is a good idea.

Let's see where phpstan/phpdoc-parser#298 will lead.

I am not sure about this additional regex matching on-top of regular phpDoc parsing.
all relevant cases should be detected by the phpdoc parser, if it is doing a good job.

if not we should improve the phpdoc parser IMO

Definitely, this is not perfect. The limitation is {@inheritDoc} ends up as part of a PhpDocTextNode, not as a tag.

take my feedback with a grain of salt. I think this is a gray area which needs @ondrejmirtes opinion.

ondrejmirtes requested changes May 2, 2026

View reviewed changes

kubawerlos force-pushed the invalid-inherit-doc-tag branch from bc204fc to fd71add Compare May 2, 2026 13:52

kubawerlos requested a review from ondrejmirtes May 2, 2026 14:09

VincentLanglet reviewed May 6, 2026

View reviewed changes

kubawerlos force-pushed the invalid-inherit-doc-tag branch from fd71add to 00f4776 Compare May 6, 2026 20:45

VincentLanglet approved these changes May 6, 2026

View reviewed changes

VincentLanglet requested a review from staabm May 6, 2026 21:06

staabm reviewed May 7, 2026

View reviewed changes

Comment thread src/Rules/PhpDoc/InvalidInheritDocTagRule.php Outdated

staabm reviewed May 7, 2026

View reviewed changes

kubawerlos added 5 commits May 7, 2026 19:05

Report @inheritDoc when there is no PHPDoc to inherit from

41844f1

Use ParentMethodHelper and separate error identifiers

1e23b0b

Skip {@inheritdoc } inside backticks

b5b18f8

Update test

90d5d85

Update message

11c08cb

kubawerlos force-pushed the invalid-inherit-doc-tag branch from cea774c to 11c08cb Compare May 7, 2026 17:06

kubawerlos mentioned this pull request May 7, 2026

Add TOKEN_PHPDOC_INLINE_TAG phpstan/phpdoc-parser#298

Open

kubawerlos marked this pull request as draft May 11, 2026 16:09

+              					continue;
+              				}
+              				if (preg_match(self::INLINE_INHERIT_DOC_REGEX, $child->text, $matches) !== 1) {

+              final class InvalidInheritDocTagRule implements Rule
+              {
+              	private const INLINE_INHERIT_DOC_REGEX = '~`[^`]*`(*SKIP)(*FAIL)|(?<![a-zA-Z0-9])\{@inheritDoc\b[^}]*\}~i';

+              			break;
+              		}
+              		if ($inheritDocTagName === null) {

Report `@inheritDoc` when there is no PHPDoc to inherit from by kubawerlos · Pull Request #5583 · phpstan/phpstan-src · GitHub

Uh oh!

Report @inheritDoc when there is no PHPDoc to inherit from - #5583

Report @inheritDoc when there is no PHPDoc to inherit from#5583kubawerlos wants to merge 5 commits intophpstan:2.1.xphpstan/phpstan-src:2.1.xfrom 6b7562617765726c6f73:invalid-inherit-doc-tag6b7562617765726c6f73/phpstan-src:invalid-inherit-doc-tagCopy head branch name to clipboard

Conversation

kubawerlos commented May 2, 2026

Uh oh!

VincentLanglet commented May 2, 2026

Uh oh!

ondrejmirtes left a comment

Choose a reason for hiding this comment

Uh oh!

kubawerlos commented May 2, 2026

Uh oh!

ondrejmirtes commented May 2, 2026

Uh oh!

VincentLanglet commented May 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

staabm May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

staabm left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Report @inheritDoc when there is no PHPDoc to inherit from#5583
kubawerlos wants to merge 5 commits into
phpstan:2.1.xfrom
6b7562617765726c6f73:invalid-inherit-doc-tag

staabm May 7, 2026 •
edited
Loading