phpdoc not inheriting method parameters

Question

In the parent class I have:

/**
 * Render the widget.
 * @param  array $options
 * @return string
 */
abstract public function render(array $options=[]);

In the child class I have:

/**
 * {@inheritDoc}
 */
public function render(array $options=[]) { /*...*/ }

But phpdoc gives me the following error for the child class:

Argument $options is missing from the Docblock of render()

Why?

Edit: if I understand it right at http://phpdoc.org/docs/latest/guides/inheritance.html, the method params should be inherited regardless the inheritDoc presence.

Bart Platak · Accepted Answer · 2014-09-24 12:30:39Z

1

@inheritDoc wasn't designed for this purpose.

The {@inheritdoc} inline tag is used in the class DocBlocks of child classes. phpDocumentor will automatically inherit the @author tag, @version tag, and @copyright tag from a parent class.

Have a look here for official documentation.

edited Sep 24, 2014 at 12:30

Bart Platak

4,4955 gold badges30 silver badges50 bronze badges

answered Sep 24, 2014 at 11:55

Maks

825 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

leyou Over a year ago

Yes but does it prevent inheritance such as explained here phpdoc.org/docs/latest/guides/inheritance.html? Method params should be inherited regardless of inheritDoc, no?

ashnazg Over a year ago

Inheritance of nearly all tags should be expected just via object inheritance. The inheritdoc inline tag only ever had one purpose -- for you to include the parent's Long Description in a designated spot in the child's docblock. The tag has no other purpose whatsoever. Granted, for years I've seen it placed in child docblocks on the expectation that it was necessary for any inheritance of docblock info at all. I fear that some IDEs may have presumed the same and included it in their autotemplating.

Community · Accepted Answer · 2017-05-23 11:51:37Z

0

If you do not redeclare the method in the child class, then I think the structure of the various output converters will only show you a list of inherited methods. Some converters will include at least the Short Description of the method from the docblock (HTML:Smarty:PHP), whereas others do not

From the accepted answer here.

edited May 23, 2017 at 11:51

CommunityBot

11 silver badge

answered Sep 24, 2014 at 16:10

Avinash Babu

6,2534 gold badges23 silver badges26 bronze badges

Collectives™ on Stack Overflow

phpdoc not inheriting method parameters

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related