tasks/ext/phpdoc/PhpDocumentorExternalTask.php
inherited
Classes
$Id: PhpDocumentorExternalTask.php 656 2009-12-14 14:10:54Z 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.
\PhpDocumentorExternalTask
Task to run phpDocumentor with an external process
This classes uses the commandline phpdoc script to build documentation. Use this task instead of the PhpDocumentorTask when you've a clash with the Smarty libraries.
- Parent(s)
- \PhpDocumentorTask < \Task < \ProjectComponent
- Author
- Michiel Rook
- Author
- Markus Fischer
- Version
- $Id: PhpDocumentorExternalTask.php 656 2009-12-14 14:10:54Z mrook $
Properties
\PhingFile
$configDir= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$configDir
string
$customtags= ''''
''Details- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$customtags
string
$defaultCategoryName= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$defaultCategoryName
string
$defaultPackageName= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$defaultPackageName
\PhingFile
$destdir= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$destdir
\PhingFile
$examplesDir= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$examplesDir
array
$filesets= 'array()'
array()Details- Type
- array
- Inherited_from
- \PhpDocumentorTask::$$filesets
string
$ignore= ''''
''Details- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$ignore
string
$ignoreTags= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$ignoreTags
bool
$ignoresymlinks= 'false'
falseDetails- Type
- bool
boolean
$javadocDesc= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$javadocDesc
boolean
$linksource= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$linksource
string
$output= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$output
string
$packages= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$packages
boolean
$parsePrivate= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$parsePrivate
boolean
$pear= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$pear
$programPath= ''phpdoc''
The path to the executable for phpDocumentor
'phpdoc'Details- Type
- n/a
array
$projDocFilesets= 'array()'
array()Details- Type
- array
- Inherited_from
- \PhpDocumentorTask::$$projDocFilesets
boolean
$quiet= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$quiet
$sourcepath= 'NULL'
NULLDetails- Type
- n/a
\PhingFile
$templateBase= ''
- Type
- \PhingFile
- Inherited_from
- \PhpDocumentorTask::$$templateBase
string
$title= ''
- Type
- string
- Inherited_from
- \PhpDocumentorTask::$$title
boolean
$undocumentedelements= 'false'
falseDetails- Type
- boolean
- Inherited_from
- \PhpDocumentorTask::$$undocumentedelements
Methods
constructArguments(
)
:
arrayConstructs an argument string for phpDocumentor
| Type | Description |
|---|---|
| array |
createProjdocfileset(
)
:
\FileSetCreates a readme/install/changelog fileset.
Inherited from: \PhpDocumentorTask::createProjdocfileset()| Type | Description |
|---|---|
| \FileSet |
findPhpDocumentorInstall(
)
:
voidSearches include_path for PhpDocumentor install and adjusts include_path appropriately.
Inherited from: \PhpDocumentorTask::findPhpDocumentorInstall()| Exception | Description |
|---|---|
| \BuildException | - if unable to find PhpDocumentor on include_path |
getDescription(
)
:
void
getLocation(
)
:
void
getOwningTarget(
)
:
void
getProgramPath(
)
:
voidReturns the path to the phpDocumentor executable
getProject(
)
:
void
getRegisterSlot(
)
:
void
getRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
void
getTaskType(
)
:
void
init(
)
:
voidOverride PhpDocumentorTask::init() because they're specific to the phpdoc API which we don't use.
main(
)
:
voidMain entrypoint of the task
| Exception | Description |
|---|---|
| \BuildException | - if the phpdoc classes can't be loaded. |
maybeConfigure(
)
:
void
setConfigdir(
\PhingFile $d
)
:
voidSet a directory to search for configuration files in.
Inherited from: \PhpDocumentorTask::setConfigdir()| Name | Type | Description |
|---|---|---|
| $d | \PhingFile |
setCustomtags(
string $sCustomtags
)
:
voidcustom tags, will be recognized and put in tags[] instead of unknowntags[].
Inherited from: \PhpDocumentorTask::setCustomtags()| Name | Type | Description |
|---|---|---|
| $sCustomtags | string |
setDefaultcategoryname(
string $name
)
:
voidSets the default category name.
Inherited from: \PhpDocumentorTask::setDefaultcategoryname()| Name | Type | Description |
|---|---|---|
| $name | string |
setDefaultpackagename(
string $name
)
:
void
| Name | Type | Description |
|---|---|---|
| $name | string |
setDescription(
)
:
void
setDestdir(
$destdir
)
:
voidSet the destination directory for the generated documentation
Inherited from: \PhpDocumentorTask::setDestdir()| Name | Type | Description |
|---|---|---|
| $destdir |
setExamplesdir(
\PhingFile $d
)
:
voidSet a directory to search for examples in.
Inherited from: \PhpDocumentorTask::setExamplesdir()| Name | Type | Description |
|---|---|---|
| $d | \PhingFile |
setIgnore(
string $sIgnore
)
:
void
| Name | Type | Description |
|---|---|---|
| $sIgnore | string |
setIgnoresymlinks(
bool $bSet
)
:
voidIgnore symlinks to other files or directories.
| Name | Type | Description |
|---|---|---|
| $bSet | bool |
setIgnoretags(
string $tags
)
:
voidSet (comma-separated) list of tags to ignore.
Inherited from: \PhpDocumentorTask::setIgnoretags()| Name | Type | Description |
|---|---|---|
| $tags | string |
setJavadocdesc(
$javadoc
)
:
voidWhether to use javadoc descriptions (more primitive).
Inherited from: \PhpDocumentorTask::setJavadocdesc()| Name | Type | Description |
|---|---|---|
| $javadoc | boolean |
setLinksource(
$b
)
:
voidSet whether to generate sourcecode for each file parsed
Inherited from: \PhpDocumentorTask::setLinksource()| Name | Type | Description |
|---|---|---|
| $b | boolean |
setLocation(
)
:
void
setOutput(
string $output
)
:
voidSet the output format (e.g. HTML:Smarty:PHP).
Inherited from: \PhpDocumentorTask::setOutput()| Name | Type | Description |
|---|---|---|
| $output | string |
setOwningTarget(
)
:
void
setPackageoutput(
string $packages
)
:
voidSet (comma-separated) list of packages to output.
Inherited from: \PhpDocumentorTask::setPackageoutput()| Name | Type | Description |
|---|---|---|
| $packages | string |
setParseprivate(
$parseprivate
)
:
voidShould private members/classes be documented
Inherited from: \PhpDocumentorTask::setParseprivate()| Name | Type | Description |
|---|---|---|
| $parseprivate | boolean |
setPear(
boolean $b
)
:
void
| Name | Type | Description |
|---|---|---|
| $b | boolean |
setPhpDocumentorOptions(
\PhingPhpDocumentorSetup $phpdoc
)
:
voidSets the options on the passed-in phpdoc setup object.
Inherited from: \PhpDocumentorTask::setPhpDocumentorOptions()| Name | Type | Description |
|---|---|---|
| $phpdoc | \PhingPhpDocumentorSetup |
setProgramPath(
$programPath
)
:
voidSets the path to the phpDocumentor executable
| Name | Type | Description |
|---|---|---|
| $programPath |
setProject(
)
:
void
setQuiet(
boolean $b
)
:
void
| Name | Type | Description |
|---|---|---|
| $b | boolean |
setRuntimeConfigurableWrapper(
)
:
voidsetSourcecode(
$b
)
:
voidSet whether to generate sourcecode for each file parsed
Inherited from: \PhpDocumentorTask::setSourcecode()| Name | Type | Description |
|---|---|---|
| $b | boolean |
setSourcepath(
$sourcepath
)
:
voidSet the source path. A directory or a comma separate list of directories.
| Name | Type | Description |
|---|---|---|
| $sourcepath |
setTarget(
$destdir
)
:
void
| Name | Type | Description |
|---|---|---|
| $destdir |
- See
- \setDestdir()
setTaskName(
)
:
void
setTaskType(
)
:
void
setTemplateBase(
$oTemplateBase
)
:
voidSet base location of all templates for this parse.
Inherited from: \PhpDocumentorTask::setTemplateBase()| Name | Type | Description |
|---|---|---|
| $oTemplateBase |
setTitle(
$title
)
:
voidSet the title for the generated documentation
Inherited from: \PhpDocumentorTask::setTitle()| Name | Type | Description |
|---|---|---|
| $title |
setUndocumentedelements(
boolean $b
)
:
voidControl whether or not warnings will be shown for undocumented elements.
Inherited from: \PhpDocumentorTask::setUndocumentedelements()Useful for identifying classes and methods that haven't yet been documented.
| Name | Type | Description |
|---|---|---|
| $b | boolean |
validate(
)
:
voidValidates that necessary minimum options have been set. Based on PhpDocumentorTask::validate().
| Exception | Description |
|---|---|
| \BuildException | if validation doesn't pass |