如何在phpdoc中集成供应商文档?

时间:2015-09-09 15:58:09

标签: php composer-php phpdoc

有没有办法配置phpdoc,以便它还会为所有已安装的供应商应用composer生成文档?

为什么呢?好吧,因为只有一个doc环境可以提供所有文档以及当前版本的应用程序和所有供应商应用程序,这将是非常好的。您可以搜索自己的doc环境,查看您应该如何与属于laravel或Zend的对象或任何您需要的对象进行对话。

我目前的phpdoc.xml如下所示:

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <title>App title</title>
    <parser>
        <default-package-name>RootNamespace\app\</default-package-name>
        <target>docs</target>
        <markers>
            <item>TODO</item>
            <item>FIXME</item>
        </markers>
        <extensions>
            <extension>php</extension>
            <extension>php3</extension>
            <extension>phtml</extension>
        </extensions>
        <visibility></visibility>
    </parser>
    <transformer>
        <target>docs</target>
    </transformer>
    <logging>
        <level>warn</level>
        <paths>
            <default>{APP_ROOT}/data/log/{DATE}.log</default>
            <errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors>
        </paths>
    </logging>
    <files>
        <ignore>src/View/*</ignore>
        <ignore>tests/*</ignore>
        <directory>src</directory>
    </files>
</phpdoc>

请不要回答“否”。有人一定想出来了。

1 个答案:

答案 0 :(得分:1)

来自@bishop的评论为我工作:

假设您的phpdoc.xml位于您的顶级目录中,则可以使用:

<files>
    <directory>vendor/**/*</directory>
    <directory>src</directory>
    <ignore>vendor/bin</ignore>
    <ignore>vend‌​or/composer</ignore>
    <ignore>src/View/*</ignore>
    <ignore>tests/*</ignore>
</files>