Yii2 apidoc不允许我将我的项目和yii框架添加到相同的文档中。

时间:2016-06-01 10:07:24

标签: yii2 phpdoc api-doc

我正在使用yiisoft / yii2-apidoc(#0.2.4)为yii2编写的项目构建文档。我已经构建了一个shell脚本来发布文档,当我只包含项目文件和我自己的cms代码库(通过composer引入)时,它工作正常。

这是代码

 #!/bin/sh

VENDOR="../vendor"

# remove existing docs
rm -rf ./frontend/web/docs

# create new docs, by drawing in all prroject code and TiCMS code. exclude the docs themselves.
$VENDOR/yiisoft/yii2-apidoc/apidoc api ./,$VENDOR/toruinteractive/ti-cms ./frontend/web/docs --interactive=0  --exclude="./frontend/web/docs"

因此,这会生成包含我所有代码的文档...

docs generated showing my classes

但是当我添加yii框架时,问题就出现了 - 为了显示我的代码继承的方法和参数,我需要它。所以添加了yii2框架的新代码是......

#!/bin/sh

VENDOR="../vendor"

# remove existing docs - this is needed as it sometimes doesn't exclude the docs folder and the output then gets cached.
rm -rf ./frontend/web/docs

# create new docs, by drawing in all prroject code and TiCMS code. exclude the docs themselves.
$VENDOR/yiisoft/yii2-apidoc/apidoc api ./,$VENDOR/toruinteractive/ti-cms,$VENDOR/yiisoft/yii2 ./frontend/web/docs --interactive=0  --exclude="./frontend/web/docs"

这会生成列出的yii2代码的文档 - 我的所有课程都已消失(请参见下面的屏幕截图)。我无法看到我在这里做错了什么,有人可以帮忙吗?

when you add yii2 into the mix you only see their classes

0 个答案:

没有答案