-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
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
Using {@inheritdoc} in apidoc #7789
Comments
It's supported but w/o |
@samdark In my case {@inheritdoc} doesn't work without |
To include vendor classes in the api documentation you have to add their path to the input directory. You can have many input directories separated by comma:
|
I have tried to include
The result is pretty weird.
And there are no classes from backend, console, frontend, common folders.
I can see all the packages (common, frontend, backend, console) in the left menu except the classes from vendor folder. Why is it happening? |
well, the apidoc command is not well suited for application documentation yet and is very specific for yii framework docs itself. You may need to make adjustments to the templates in some places. |
duplicate of #11635 |
I am using {inheritdoc} inline tag to inherit the parent description.
After generating documentation with yii2-apidoc I am expecting to get parent description in the description section, but I am getting
{@inheritdoc}
as a text.Is {@inheritdoc} support is turned off or I have missed something?
UPD: it looks like the reason
{inheritdoc}
doesn't work is because apidoc doesn't know where the parent class is situated.In my case the parent class is
yii\web\AssetBundle
.I think so, because the apidoc doesn't create the link to
yii\web\AssetBundle
. I am using advanced application template. How can I force apidoc to analyze vendor folder. As was mentioned before I specified the project folder(which includes frontend,backend, vendor).The text was updated successfully, but these errors were encountered: