ApiGen task (http://apigen.org).
Use \Project#createTask to register a new Task.
package |
phing.tasks.ext.apigen |
---|---|
author |
Martin Srank martin@smasty.net |
author |
Jaroslav Hanslík kukulich@kukulich.cz |
since | 2.4.10 |
constructArguments() : string
string
getDescription() : string
string
The text description of the task
getLocation() : \Location
getOwningTarget() : \Target
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 | |
---|---|
setAccessLevels(string $accessLevels)
Documentation only for methods and properties with the given access level will be generated.
string
setAllowedHtml(string $allowedHtml)
string
setAutocomplete(string $autocomplete)
string
setBaseUrl(string $baseUrl)
string
setCharset(string $charset)
string
setConfig(string $config)
string
setDebug(boolean $debug)
boolean
setDeprecated(boolean $deprecated)
boolean
setDescription(string $desc)
string
The text describing the task
setDestination(string $destination)
string
setDownload(boolean $download)
boolean
setExclude(string $exclude)
string
setExecutable(string $executable)
string
setExtensions(string $extensions)
string
setGoogleAnalytics(string $googleAnalytics)
string
setGoogleCseId(string $googleCseId)
string
setGoogleCseLabel(string $googleCseLabel)
string
setGroups(string $groups)
string
setInternal(boolean $internal)
boolean
setLocation(\Location $location)
setMain(string $main)
string
setOwningTarget(\Target $target)
setPhp(boolean $php)
boolean
setProject(\Project $project) : void
setQuiet(boolean $quiet)
boolean
setReport(string $report)
string
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setSkipDocPath(string $skipDocPath)
string
setSkipDocPrefix(string $skipDocPrefix)
string
setSource(string $source)
string
setSourceCode(boolean $sourceCode)
boolean
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
setTemplateConfig(string $templateConfig)
string
setTitle(string $title)
string
setTodo(boolean $todo)
boolean
setTree(boolean $tree)
boolean
setUpdateCheck(boolean $updateCheck)
boolean
setWipeout(boolean $wipeout)
boolean
executable : string
var |
---|
string
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project