Wrapper around PhpDocumentor2 (so we retain
PHP 5.2 compatibility in the main task)
author
|
Michiel Rook mrook@php.net
|
version
|
$Id: 9f22f2863b649ddf3820399fd5738c58900b3a24 $
|
since
|
2.4.10
|
package
|
phing.tasks.ext.phpdoc
|
Methods
Find the correct php documentor path
findPhpDocumentorPath() : null|string
Finds and initializes the phpDocumentor installation
initializePhpDocumentor()
Build a list of files (from the fileset elements)
and call the phpDocumentor parser
parseFiles() : string
Runs phpDocumentor 2
run()
Sets the default package name
setDefaultPackageName(string $defaultPackageName)
Arguments
$defaultPackageName
string
Sets destination/target directory
setDestDir(\PhingFile $destDir)
Sets filesets array
setFilesets(array<mixed,\FileSet> $filesets)
setPharLocation
setPharLocation(string $pharLocation)
Sets project instance
setProject(\Project $project)
Sets the template to use
setTemplate(string $template)
Sets the title of the project
setTitle(string $title)
Properties
Phing project instance
project : \Project
List of filesets
filesets : array<mixed,\FileSet>
Destination/target directory
destDir : \PhingFile
name of the template to use
template : string
Title of the project
title : string
Name of the default package
defaultPackageName : string
Path to the phpDocumentor 2 source
phpDocumentorPath : string
Path to the phpDocumentor .phar
pharLocation : string
app
app : \phpDocumentor\Application
Type(s)
\phpDocumentor\Application