classes/phing/tasks/ext/docblox/DocBloxTask.php

\DocBloxTask
jump to top

DocBlox Task (http://www.docblox-project.org)

Use {@link Project#createTask} to register a new Task.

string
                 $destDir= ''

Destination/target directory

Details

\FileSet[]
                 $filesets= 'array'

List of filesets

Default valuearrayDetails

boolean
                 $quiet= 'true'

Force DocBlox to be quiet

Default valuetrueDetails

string
                 $title= ''

Title of the project

Details

 
            createFileSet(
          
          )
        
        :
        \FileSet

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

Returns

Type	Description
\FileSet

 
            initializeDocBlox(
          
          )
        
        :

Finds and initializes the DocBlox installation

Task entry point

Details

 
            parseFiles(
          
          )
        
        :
        string

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

Returns

Type	Description
string

 
            setDestDir(
          string $destDir
          )
        
        :

Sets destination/target directory

Parameters

Name	Type	Description
$destDir	string

 
            setOutput(
          string $output
          )
        
        :

Convenience setter (@see setDestDir)

Parameters

Name	Type	Description
$output	string

 
            setQuiet(
          boolean $quiet
          )
        
        :

Forces DocBlox to be quiet

Parameters

Name	Type	Description
$quiet	boolean

 
            setTitle(
          \strings $title
          )
        
        :

Sets the title of the project

Parameters

Name	Type	Description
$title	\strings