@inheritdoc not working

[neoacevedo]

{@inheritdoc} is not pulling the documentation for classes, methods and properties.

{@inheritDoc} is rendered as plain text, meaning that in the documentation, it will have the literal {@inheritDoc} instead of, at least, the same current non-doc as in {@inheritdoc}

[atangemann]

I encountered the same problem. Let me explain this in detail:
When I try to create the api documentation, I issue this command:
vendor/bin/apidoc api "api/modules,frontend/controllers,frontend/models,common/controllers,common/models" public --exclude="vendor/"
Then the documentation is created, but the {@inheritdoc} comments are missing.

When I include the yii framework, I issue this command:
vendor/bin/apidoc api "api/modules,frontend/controllers,frontend/models,common/controllers,common/models,vendor/yiisoft/yii2/" public --exclude="vendor/"
Then the {@inheritdoc} comments are filled, but looking at the index.html file will only show yii classes.

I can search for my classes but they are not shown in the list to the left of the index.html file.
Additionally all the documentation files for the yii framework are created, which is not necessary.
I think the OP has the same problem.

[neoacevedo]

All the documentation for the yii framework is generated because you have specified it in the api parameter:

vendor/bin/apidoc api "api/modules,frontend/controllers,frontend/models,common/controllers,common/models,vendor/yiisoft/yii2/" public --exclude="vendor/".

[neoacevedo]

Another issue for @inheritdoc is related to the following error:

Method tableName|attributeLabels|behaviors has no parent to inherit from in namespace\models\ModelFile.. It's applied to any class who sets the inhertdoc in the docblock.

BTW, the tag @see isn't rendering anything neither.

[atangemann]

I have to specify "vendor/yiisoft/yii2" because the @inheritdocs comments would be missing otherwise. See my example above.

All the documentation for the yii framework is generated because you have specified it in the api parameter:

[arogachev]

If you mean different variations, it was fixed in #218. I did a retest and all 4 variations:

• @inheritdoc
• @inheritDoc
• {@inheritdoc}
• {@inheritDoc}

work as expected for methods and properties.

[arogachev]

#194 (comment)

So for methods and properties I can't reproduce initial issue with the latest master. For classes @inheritdoc indeed is not supported, I created a new issue - #246. As I wrote there, this seems to be a rare case, so it won't be implemented right away.

#194 (comment)

As for generating docs for a user project, it's out of context of @inheritdoc and seems to be a duplicate of #49 and #131.

#194 (comment)

Please provide a minimal snippet to reproduce the problem. Also for @see tag a new issue is probably needed.

[arogachev]

Closing this one. Feel free to reopen with more info / snippets.

[neoacevedo]

#194 (comment)

Please provide a minimal snippet to reproduce the problem. Also for @see tag a new issue is probably needed.

Since it comes from last year, I forgot to mention the @see tag issue has been solved, not else, for me, the inheritdoc tag.

This is a small code with inheritdoc tag used in a \yii\rest\ActiveController controller and it applies to web controllers:

    /** {@inheritdoc} */
    public $modelClass = 'app\models\User';

    /**
     * {@inheritdoc}
     */
    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['contentNegotiator']['formats']['application/json'] = Response::FORMAT_JSON;
        return $behaviors;
    }

The apidoc result for behavior method:

For the attribute $modelClass:

And I'm using the version 2.1.6.

[samdark]

Please check master.

[arogachev]

@samdark It should work on 2.1.6 too.

@neoacevedo Please provide more relevant code, I still can't reproduce the issue.

For yii\rest\Controller as you can see it works for both properties and methods:

• https://www.yiiframework.com/doc/api/2.0/yii-rest-controller#$enableCsrfValidation-detail (can't find $modelClass neither in web nor rest controller).
• https://www.yiiframework.com/doc/api/2.0/yii-base-component#behaviors()-detail.