tasks/ext/docblox/DocBloxTask.php
Show:
inherited
inherited
Classes
\DocBloxTask
Package: phing\tasks\ext\docblox
DocBlox Task (http://www.docblox-project.org)
- Parent(s)
- \Task < \ProjectComponent
- Author
- Michiel Rook
- Since
- 2.4.6
- Version
- $Revision: 1389 $
Properties
boolean
$quiet= 'true'
Force DocBlox to be quiet
Default value
trueDetails- Type
- boolean
string
$title= '""'
Title of the project
Default value
""Details- Type
- string
Methods
createFileSet(
)
:
\FileSetNested creator, adds a set of files (nested fileset attribute).
Returns
| Type | Description |
|---|---|
| \FileSet |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidinitializeDocBlox(
)
:
voidFinds and initializes the DocBlox installation
log(
)
:
voidmaybeConfigure(
)
:
voidparseFiles(
)
:
stringBuild a list of files (from the fileset elements) and call the DocBlox parser
Returns
| Type | Description |
|---|---|
| string |
perform(
)
:
voidsetDescription(
)
:
voidsetDestDir(
\PhingFile $destDir
)
:
voidSets destination/target directory
Parameters
| Name | Type | Description |
|---|---|---|
| $destDir | \PhingFile |
setLocation(
)
:
voidsetOutput(
\PhingFile $output
)
:
voidConvenience setter (@see setDestDir)
Parameters
| Name | Type | Description |
|---|---|---|
| $output | \PhingFile |
setOwningTarget(
)
:
voidsetProject(
)
:
voidsetQuiet(
boolean $quiet
)
:
voidForces DocBlox to be quiet
Parameters
| Name | Type | Description |
|---|---|---|
| $quiet | boolean |
setRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetTitle(
\strings $title
)
:
voidSets the title of the project
Parameters
| Name | Type | Description |
|---|---|---|
| $title | \strings |