zot24
11/28/2014 - 11:32 AM

PHP Dox example config file

PHP Dox example config file

<?xml version="1.0" encoding="utf-8" ?>
<phpdox xmlns="http://phpdox.net/config">
  <project name="MyProjectName" source="MyBaseDir" workdir="phpdox">
    <collector publiconly="false">
      <include mask="*/source1/**/*.php" />
      <include mask="*/source2/**/*.php" />
      <exclude mask="*autoload.php" />
    </collector>

    <generator output=".">
      <enrich base="logs">
        <source type="build" />
        <source type="git" />
        <source type="phploc" />
        <source type="checkstyle" />
        <source type="pmd" />
        <source type="phpunit" />
      </enrich>

      <build engine="html" enabled="true" output="api">
        <file extension="html" />
      </build>
    </generator>
  </project>
</phpdox>