# tasks/ext/docblox/DocBloxTask.php

## \DocBloxTask
jump to top

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

`\PhingFile $destDir= 'null'`

Destination/target directory

Default value `null` Details

Type
  \PhingFile

`\FileSet[] $filesets= 'array()'`

List of filesets

Default value `array()`Details

Type
  \FileSet[]

`boolean $quiet= 'true'`

Force DocBlox to be quiet

Default value `true` Details

Type
  boolean

`string $title= '""'`

Title of the project

Default value`""`Details

Type
  string

### Methods

`createFileSet( ) : \FileSet`

Nested creator, adds a set of files (nested fileset attribute).

Returns

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

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

`initializeDocBlox( ) : void`

Finds and initializes the DocBlox installation

`log( ) : void`

`main( ) : void`

Task entry point

Details

See
  \Task::main()

`maybeConfigure( ) : void`

`parseFiles( ) : string`

Build a list of files (from the fileset elements) and call the DocBlox parser

Returns

Type | Description
--- | ---
string |

`perform( ) : void`

`setDescription( ) : void`

`setDestDir( \PhingFile $destDir ) : void`

Sets destination/target directory

Parameters

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

`setLocation( ) : void`

`setOutput( \PhingFile $output ) : void`

Convenience setter (@see setDestDir)

Parameters

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

`setOwningTarget( ) : void`

`setProject( ) : void`

`setQuiet( boolean $quiet ) : void`

Forces DocBlox to be quiet

Parameters

Name | Type | Description
--- | --- | ---
$quiet | boolean |

`setRuntimeConfigurableWrapper( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

`setTitle( \strings $title ) : void`

Sets the title of the project

Parameters

Name | Type | Description
--- | --- | ---
$title | \strings |

Documentation was generated by DocBlox 0.17.1.