警告:未启用PHPLoc浓缩或在phpDox中找不到phploc.xml

时间:2016-06-28 16:36:57

标签: php jenkins ant build.xml phploc

我在项目构建时使用Jenkins和Ant为我的PHP项目生成API文档:

<?xml version="1.0" encoding="UTF-8"?>
<project name="MyProject" default="full-build">
    <property name="pdepend" value="/usr/share/.composer/vendor/bin/pdepend" />
    ...
    <target name="full-build" depends="prepare,static-analysis,phpdox" />
    <target name="prepare" unless="prepare.done" depends="clean">
        <mkdir dir="${basedir}/build/api" />
        ...
    </target>
    <target name="clean" unless="clean.done">
        <delete dir="${basedir}/build/api" />
        ...
    </target>
    <target name="static-analysis">
        <parallel threadCount="2">
            <sequential>
                <antcall target="pdepend" />
                <antcall target="phpmd" />
            </sequential>
            <antcall target="lint" />
            <antcall target="phpcpd" />
            <antcall target="phpcs" />
            <antcall target="phploc" />
        </parallel>
    </target>
    <target name="pdepend" unless="pdepend.done" depends="prepare">
        ...
    </target>
    <target name="phpmd" unless="phpmd.done">
        ...
    </target>
    <target name="lint" unless="lint.done">
        ...
    </target>
    <target name="phpcpd" unless="phpcpd.done">
        ...
    </target>
    <target name="phpcs" unless="phpcs.done">
        ...
    </target>
    <target name="phpdox" depends="phploc,phpcs,phpmd" unless="phpdox.done">
        <exec executable="${phpdox}" dir="${basedir}/build" taskname="phpdox">
            <arg value="--file" />
            <arg value="${basedir}/build/phpdox.xml" />
        </exec>
        <property name="phpdox.done" value="true" />
    </target>
    <target name="phploc" unless="phploc.done">
        ...
    </target>
</project>

构建完成后,我打开API文档的index.xhtml,会显示警告:

  

警告:未启用PHPLoc浓缩或未找到phploc.xml。

enter image description here

为什么会显示此警告以及如何解决由此引起的问题?

1 个答案:

答案 0 :(得分:4)

phpDox需要生成phploc.xml个文件。您的目标phploc是否会生成此类文件(参数:--log-xml <filename>)?

示例目标phploc

<target name="phploc" unless="phploc.done">
    <exec executable="${phploc}" taskname="phploc">
        <arg value="--count-tests" />
        <arg value="--log-csv" />
        <arg path="${basedir}/build/logs/phploc.csv" />
        <arg value="--log-xml" />
        <arg path="${basedir}/build/logs/phploc.xml" />
        <arg path="....." />
    </exec>
    <property name="phploc.done" value="true"/>
</target>

如果未找到或启动PHPLOC richher,则应从phpDox Ant构建脚本反馈中省略以下行:

[phpdox] [06.07.2016 - 16:37:58] Registered enricher 'phploc'