Предупреждение: обогащение PHPLoc не включено или phploc.xml не найден в phpDox

Я создаю документацию по API для моего PHP-проекта с Jenkins и Ant по созданию проекта:

<?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>

Когда сборка завершена, и я открываю index.xhtml из документа API отображается предупреждение:

Предупреждение: обогащение PHPLoc не включено или phploc.xml не найден.

введите описание изображения здесь

Почему отображается это предупреждение и как решить проблему, вызванную этим?

0

Решение

phpDox требует phploc.xml файл, который будет создан. Ваша цель phploc генерирует такой файл (param: --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 не было найдено или запущено, в обратной связи скрипта сборки phpDox Ant следует пропустить следующую строку:

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

Другие решения

Других решений пока нет …

По вопросам рекламы [email protected]
Adblock
detector