C.57 PhpDocumentorExternalTask
Prev | Appendix C. Optional tasks | Next

## C.57 PhpDocumentorExternalTask

This task is now deprecated in favor of the Section C.56, “PhpDocumentor2Task”.

This is the same as the Section C.55, “PhpDocumentorTask” but uses the command line application. Use this as a fallback in case you're running into troubles when using the phpDocumentor-library with the PhpDocumentorTask directly, e.g. when you're using Smarty and have Smarty in your library path too.

This task supports everything the PhpDocumentorTask supports, differences are documented below.

Table C.80: Parameters

Name | Type | Description | Default | Required
--- | --- | --- | --- | ---
`programpath` | `String` | Path to the phpdoc executable (relative or absolute). | n/a | No
`sourcepath` | `String` | A directory to scan for parsable files. Supports multiple directories separated with a comma. | n/a | Yes, if no `<fileset>` is given

Table C.81: Unsupported Parameters

Name | Description
--- | ---
`configdir` | Currently not supported. The attribute will be ignored and a warning messag will be generated. The build continues (to ease when changing an existing phpdoc task) however this may have unexpected side effects.

### C.57.1 Example

    <phpdocext title="API Documentation"
      programpath="/usr/bin/phpdoc"
      destdir="apidocs"
      sourcecode="false"
      output="HTML:Smarty:PHP">
       <fileset dir="./classes">
          <include name="**/*.php" />
       </fileset>
       <projdocfileset dir=".">
          <include name="README" />
          <include name="INSTALL" />
          <include name="CHANGELOG" />
       </projdocfileset>
    </phpdocext>

Prev | Up | Next
C.56 PhpDocumentor2Task | Home | C.58 PhpLintTask