PhpDocumentor2 Task (http://www.phpdoc.org) Based on the DocBlox Task
Use \Project#createTask to register a new Task.
author |
Michiel Rook mrook@php.net |
---|---|
version |
$Id: c4b22d22e82b6788fe6411d807611fa978eb1256 $ |
since | 2.4.10 |
package |
phing.tasks.ext.phpdoc |
addFileSet(\FileSet $fs) : void
getDescription() : string
string
The text description of the task
getLocation() : \Location
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName)
string
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)
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()
setDefaultPackageName(string $defaultPackageName)
string
setDescription(string $desc)
string
The text describing the task
setLocation(\Location $location)
setOwningTarget(\Target $target)
setProject(\Project $project)
setQuiet(boolean $quiet)
deprecated | |
---|---|
boolean
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setTemplate(\strings $template)
\strings
setTitle(\strings $title)
\strings
template : string
var |
---|
string
title : string
var |
---|
string
defaultPackageName : string
var |
---|
string
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project