C.73 PhpDocumentor2Task

This task runs phpDocumentor 2, a PHP 5.3-compatible API documentation tool. This project is the result of the merge of the phpDocumentor and DocBlox projects.

Table C.99: Attributes

NameTypeDescriptionDefaultRequired
titleStringTitle of the project.n/aNo
destdirStringDestination directory for output files.n/aYes
quietBooleanDEPRECATEDn/aNo
templateStringName of the documentation template to use.responsive-twigNo
defaultPackageNameStringName of the default package.DefaultNo
pharlocationStringLocation of the phpDocumentor PHAR package.n/aNo

C.73.1 Example

<phpdoc2 title="API Documentation"
  destdir="apidocs"
  template="responsive-twig">
   <fileset dir="./classes">
      <include name="**/*.php" />
   </fileset>
</phpdoc2>

C.73.2 Supported Nested Tags

  • fileset - Files that should be included for parsing