Task to run phpDocumentor with an external process
This classes uses the commandline phpdoc script to build documentation. Use this task instead of the PhpDocumentorTask when you've a clash with the Smarty libraries.
author |
Michiel Rook mrook@php.net |
---|---|
author |
Markus Fischer markus@fischer.name |
version |
$Id: 6a6c740651bb91c9854fcdf0cb1d7e768b84f805 $ |
package |
phing.tasks.ext.phpdoc |
setProgramPath($programPath)
getProgramPath()
setSourcepath($sourcepath)
setIgnoresymlinks(bool $bSet)
bool
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
constructArguments() : array
array
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws |
---|
validate()
throws |
if validation doesn't pass |
---|
setTitle($title)
setDestdir(\PhingFile $destdir)
setTarget(\PhingFile $destdir)
setOutput(string $output)
string
setSourcecode($b)
setLinksource($b)
setQuiet(boolean $b)
boolean
setParseprivate($parseprivate)
setJavadocdesc($javadoc)
setPackageoutput(string $packages)
string
setExamplesdir(\PhingFile $d)
setConfigdir(\PhingFile $d)
setDefaultpackagename(string $name)
string
setDefaultcategoryname(string $name)
string
setPear(boolean $b)
boolean
createProjdocfileset() : \FileSet
setUndocumentedelements(boolean $b)
Useful for identifying classes and methods that haven't yet been documented.
boolean
setTemplateBase(\PhingFile $oTemplateBase)
setIgnore(string $sIgnore)
string
findPhpDocumentorInstall()
throws |
|
---|
setPhpDocumentorOptions(\PhingPhpDocumentorSetup $phpdoc)
setOwningTarget(\Target $target)
getOwningTarget() : \Target
getTaskName() : string
string
Name of this task
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
getTaskType() : string
string
The type of this task (XML Tag)
setTaskType($name)
getRegisterSlot(string $slotName)
string
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
setDescription(string $desc)
string
The text describing the task
getDescription() : string
string
The text description of the task
getLocation() : \Location
setLocation(\Location $location)
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
maybeConfigure()
perform()
setProject(\Project $project)
getProject() : \Project
programPath :
sourcepath :
ignoresymlinks : bool
var |
ignore symlinks to other files or directories |
---|
bool
title : string
var |
Title for browser window / package index. |
---|
string
destdir : \PhingFile
filesets : array
var |
FileSet[] Filesets for files to parse. |
---|
array
projDocFilesets : array
var |
FileSet[] Project documentation (README/INSTALL/CHANGELOG) files. |
---|
array
output : string
var |
Package output format. |
---|
string
linksource : boolean
var |
Whether to generate sourcecode for each file parsed. |
---|
boolean
parsePrivate : boolean
var |
Whether to parse private members. |
---|
boolean
javadocDesc : boolean
var |
Whether to use javadoc descriptions (more primitive). |
---|
boolean
templateBase : \PhingFile
quiet : boolean
var |
Wheter to suppress output. |
---|
boolean
packages : string
var |
Comma-separated list of packages to output. |
---|
string
ignoreTags : string
var |
Comma-separated list of tags to ignore. |
---|
string
defaultPackageName : string
var |
Default package name. |
---|
string
defaultCategoryName : string
var |
Default category name. |
---|
string
examplesDir : \PhingFile
configDir : \PhingFile
pear : boolean
var |
Whether to parse as a PEAR repository. |
---|
boolean
undocumentedelements : boolean
var |
Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented. |
---|
boolean
ignore : string
var |
files to ignore |
---|
string
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project