# tasks/ext/phpdoc/PhpDocumentorTask.php

$Id: PhpDocumentorTask.php 1101 2011-05-18 17:49:55Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

## \PhpDocumentorTask
jump to top

Package: phing\tasks\ext\phpdoc

Task to run PhpDocumentor.

Parent(s)
  \Task < \ProjectComponent
Children
  \PhpDocumentorExternalTask
Author
  Hans Lellelid
Author
  Michiel Rook
Version
  $Id: PhpDocumentorTask.php 1101 2011-05-18 17:49:55Z mrook $

### Properties

`\PhingFile $configDir= ''`

Directory in which to look for configuration files.
Details

Type
  \PhingFile

`string $customtags= ''''`

custom tags, will be recognized and put in tags[] instead of unknowntags[].
Default value`''`Details

Type
  string

`string $defaultCategoryName= ''`

Default category name.
Details

Type
  string

`string $defaultPackageName= ''`

Default package name.
Details

Type
  string

`\PhingFile $destdir= ''`

The target directory for output files.
Details

Type
  \PhingFile

`\PhingFile $examplesDir= ''`

Directory in which to look for examples.
Details

Type
  \PhingFile

`array $filesets= 'array()'`

FileSet[] Filesets for files to parse.
Default value `array()`Details

Type
  array

`string $ignore= ''''`

files to ignore
Default value`''`Details

Type
  string

`string $ignoreTags= ''`

Comma-separated list of tags to ignore.
Details

Type
  string

`boolean $javadocDesc= 'false'`

Whether to use javadoc descriptions (more primitive).
Default value `false` Details

Type
  boolean

`boolean $linksource= 'false'`

Whether to generate sourcecode for each file parsed.
Default value `false` Details

Type
  boolean

`string $output= ''`

Package output format.
Details

Type
  string

`string $packages= ''`

Comma-separated list of packages to output.
Details

Type
  string

`boolean $parsePrivate= 'false'`

Whether to parse private members.
Default value `false` Details

Type
  boolean

`boolean $pear= 'false'`

Whether to parse as a PEAR repository.
Default value `false` Details

Type
  boolean

`array $projDocFilesets= 'array()'`

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.
Default value `array()`Details

Type
  array

`boolean $quiet= 'false'`

Wheter to suppress output.
Default value `false` Details

Type
  boolean

`\PhingFile $templateBase= ''`

Base directory for locating template files.
Details

Type
  \PhingFile

`string $title= ''`

Title for browser window / package index.
Details

Type
  string

`boolean $undocumentedelements= 'false'`

Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented.
Default value `false` Details

Type
  boolean

### Methods

`createFileset( ) : \FileSet`

Creates a FileSet.

Returns

Type | Description
--- | ---
\FileSet |

`createProjdocfileset( ) : \FileSet`

Creates a readme/install/changelog fileset.

Returns

Type | Description
--- | ---
\FileSet |

`findPhpDocumentorInstall( ) : void`

Searches include_path for PhpDocumentor install and adjusts include_path appropriately.

Throws

Exception | Description
--- | ---
\BuildException | - if unable to find PhpDocumentor on include_path

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

`log( ) : void`

`main( ) : void`

Main entrypoint of the task Loads the necessary environment for running PhpDoc, then runs PhpDoc

Throws

Exception | Description
--- | ---
\BuildException | - if the phpdoc classes can't be loaded.

`maybeConfigure( ) : void`

`perform( ) : void`

`setConfigdir( \PhingFile $d ) : void`

Set a directory to search for configuration files in.

Parameters

Name | Type | Description
--- | --- | ---
$d | \PhingFile |

`setCustomtags( string $sCustomtags ) : void`

custom tags, will be recognized and put in tags[] instead of unknowntags[].

Parameters

Name | Type | Description
--- | --- | ---
$sCustomtags | string |

`setDefaultcategoryname( string $name ) : void`

Sets the default category name.

Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`setDefaultpackagename( string $name ) : void`

Sets the default package name.

Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`setDescription( ) : void`

`setDestdir( $destdir ) : void`

Set the destination directory for the generated documentation

Parameters

Name | Type | Description
--- | --- | ---
$destdir |  |

`setExamplesdir( \PhingFile $d ) : void`

Set a directory to search for examples in.

Parameters

Name | Type | Description
--- | --- | ---
$d | \PhingFile |

`setIgnore( string $sIgnore ) : void`

Set files to ignore

Parameters

Name | Type | Description
--- | --- | ---
$sIgnore | string |

`setIgnoretags( string $tags ) : void`

Set (comma-separated) list of tags to ignore.

Parameters

Name | Type | Description
--- | --- | ---
$tags | string |

`setJavadocdesc( $javadoc ) : void`

Whether to use javadoc descriptions (more primitive).

Parameters

Name | Type | Description
--- | --- | ---
$javadoc |  | boolean

`setLinksource( $b ) : void`

Set whether to generate sourcecode for each file parsed

Parameters

Name | Type | Description
--- | --- | ---
$b |  | boolean

`setLocation( ) : void`

`setOutput( string $output ) : void`

Set the output format (e.g. HTML:Smarty:PHP).

Parameters

Name | Type | Description
--- | --- | ---
$output | string |

`setOwningTarget( ) : void`

`setPackageoutput( string $packages ) : void`

Set (comma-separated) list of packages to output.

Parameters

Name | Type | Description
--- | --- | ---
$packages | string |

`setParseprivate( $parseprivate ) : void`

Should private members/classes be documented

Parameters

Name | Type | Description
--- | --- | ---
$parseprivate |  | boolean

`setPear( boolean $b ) : void`

Set whether to parse as PEAR repository.

Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`setPhpDocumentorOptions( \PhingPhpDocumentorSetup $phpdoc ) : void`

Sets the options on the passed-in phpdoc setup object.

Parameters

Name | Type | Description
--- | --- | ---
$phpdoc | \PhingPhpDocumentorSetup |

`setProject( ) : void`

`setQuiet( boolean $b ) : void`

Set whether to suppress output.

Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`setRuntimeConfigurableWrapper( ) : void`

`setSourcecode( $b ) : void`

Set whether to generate sourcecode for each file parsed

Parameters

Name | Type | Description
--- | --- | ---
$b |  | boolean

`setTarget( $destdir ) : void`

Alias for {@link setDestdir()}.

Parameters

Name | Type | Description
--- | --- | ---
$destdir |  |

Details

See
  \setDestdir()

`setTaskName( ) : void`

`setTaskType( ) : void`

`setTemplateBase( $oTemplateBase ) : void`

Set base location of all templates for this parse.

Parameters

Name | Type | Description
--- | --- | ---
$oTemplateBase |  |

`setTitle( $title ) : void`

Set the title for the generated documentation

Parameters

Name | Type | Description
--- | --- | ---
$title |  |

`setUndocumentedelements( boolean $b ) : void`

Control whether or not warnings will be shown for undocumented elements.

Useful for identifying classes and methods that haven't yet been documented.

Parameters

Name | Type | Description
--- | --- | ---
$b | boolean |

`validate( ) : void`

Validates that necessary minimum options have been set.

Throws

Exception | Description
--- | ---
\BuildException | if validation doesn't pass

Documentation was generated by DocBlox 0.17.1.