This task is now deprecated in favor of the Section C.56, “PhpDocumentor2Task”.
This task runs phpDocumentor, an auto-documentation tool for PHP similar to Javadoc.
Table C.78: Attributes
Name | Type | Description | Default | Required |
---|---|---|---|---|
title | String | Title for browser window / package index. | n/a | No |
destdir | String | Destination directory for output files. | n/a | Yes |
target | String | Alias of destdir ("target" is config param used by
PhpDocumentor) | n/a | |
output | String | Output format (such as HTML:Smarty:PHP ). | n/a | Yes |
sourcecode | Boolean | Generate syntax-highlighted sourcecode file for each file parsed? | false | No |
examplesdir | String | Path to directory in which to look for example documentation. | n/a | No |
parseprivate | Boolean | Parse @internal and elements marked private. | false | No |
javadocdesc | Boolean | JavaDoc-compliant description parsing. Use on/off, default off (more flexibility) | false | No |
quiet | Boolean | Suppress output to STDOUT. | false | No |
packageoutput | String | Output documentation only for selected packages. Use a comma-delimited list | n/a | No |
ignoretags | String | Comma-separated list of tags to ignore (@package, @subpackage, @access and @ignore may not be ignored). | n/a | No |
defaultpackagename | String | name to use for the default package. If not specified, uses 'default' | n/a | No |
defaultcategoryname | String | name to use for the default category. If not specified, uses 'default' | n/a | No |
pear | Boolean | Treat parse dirs as PEAR repository? (package is directory, _members are @access private) | false | No |
templatebase | String | Set base dirctory of all templates for this parse. | n/a | No |
undocumentedelements | Boolean | Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented. | false | No |
customtags | Boolean | Custom tags, will be recognized and put in tags[] instead of unknowntags[]. | false | No |
ignore | String | List of files to ignore, separated by ','. | n/a | No |
<phpdoc title="API Documentation" 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> </phpdoc>
fileset
- Files that should be included for
parsing
projdocfileset
- Files that should be treated as
README/INSTALL/CHANGELOG files