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: b72762694ae5d5619ecebf9b66c08bd6ff868821 $ |
package |
phing.tasks.ext.phpdoc |
constructArguments() : array
array
createProjdocfileset() : \FileSet
findPhpDocumentorInstall()
throws |
|
---|---|
getDescription() : string
string
The text description of the task
getLocation() : \Location
getOwningTarget() : \Target
getProgramPath()
getProject() : \Project
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
throws | |
---|---|
setConfigdir(\PhingFile $d)
setDefaultcategoryname(string $name)
string
setDefaultpackagename(string $name)
string
setDescription(string $desc)
string
The text describing the task
setDestdir(\PhingFile $destdir)
setExamplesdir(\PhingFile $d)
setIgnore(string $sIgnore)
string
setIgnoresymlinks(boolean $bSet)
boolean
setJavadocdesc( $javadoc)
setLinksource( $b)
setLocation(\Location $location)
setOutput(string $output)
string
setOwningTarget(\Target $target)
setPackageoutput(string $packages)
string
setParseprivate( $parseprivate)
setPear(boolean $b)
boolean
setPhpDocumentorOptions(\PhingPhpDocumentorSetup $phpdoc)
setProgramPath( $programPath)
setProject(\Project $project) : void
setQuiet(boolean $b)
boolean
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setSourcecode( $b)
setSourcepath( $sourcepath)
setTarget(\PhingFile $destdir)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setTitle( $title)
setUndocumentedelements(boolean $b)
Useful for identifying classes and methods that haven't yet been documented.
boolean
validate()
throws |
if validation doesn't pass |
---|---|
programPath :
sourcepath :
ignoresymlinks : boolean
var |
ignore symlinks to other files or directories |
---|
boolean
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