PhpDocumentor2Wrapper

Wrapper around PhpDocumentor2 (so we retain PHP 5.2 compatibility in the main task)

author	Michiel Rook mrook@php.net
version	$Id: 21468fba5ffbacb5ab009610d9a17cc1a139a367 $
since	2.4.10
package	phing.tasks.ext.phpdoc

Methods

Sets project instance

setProject(\Project $project)

Arguments

$project

\Project

Sets filesets array

setFilesets(\FileSet[] $filesets)

Arguments

$filesets

\FileSet[]

Sets destination/target directory

setDestDir(\PhingFile $destDir)

Arguments

$destDir

\PhingFile

Sets the template to use

setTemplate(\strings $template)

Arguments

$template

\strings

Sets the title of the project

setTitle(\strings $title)

Arguments

$title

\strings

Finds and initializes the phpDocumentor installation

initializePhpDocumentor()

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

parseFiles() : string

Response

string

Transforms the parsed files

transformFiles()

Runs phpDocumentor 2

run()

Properties

Phing project instance

project : \Project

var

Type(s)

\Project

List of filesets

filesets : \FileSet[]

var

Type(s)

\FileSet[]

Destination/target directory

destDir : \PhingFile

var

Type(s)

\PhingFile

name of the template to use

template : string

var

Type(s)

string

Title of the project

title : string

var

Type(s)

string

Path to the phpDocumentor 2 source

phpDocumentorPath : string

var

Type(s)

string

app

app : \phpDocumentor\Application

var

Type(s)

\phpDocumentor\Application