Phing API Documentation
Back to top  

PhpDocumentorTask

Extends \Task

Task to run PhpDocumentor.

Use {@link Project#createTask} to register a new Task.

author

Hans Lellelid hans@xmpl.org
author

Michiel Rook mrook@php.net
version

$Id: 0d5d03ba0499556fb210b95baeba574de2b869f2 $
package

phing.tasks.ext.phpdoc

Methods

Set the title for the generated documentation

setTitle($title)

Arguments

$title

Set the destination directory for the generated documentation

setDestdir(\PhingFile $destdir)

Arguments

$destdir

\PhingFile

Alias for {@link setDestdir()}.

setTarget(\PhingFile $destdir)
see \setDestdir()

Arguments

$destdir

\PhingFile

Set the output format (e.g. HTML:Smarty:PHP).

setOutput(string $output)

Arguments

$output

string

Set whether to generate sourcecode for each file parsed

setSourcecode($b)

Arguments

$b

Set whether to generate sourcecode for each file parsed

setLinksource($b)

Arguments

$b

Set whether to suppress output.

setQuiet(boolean $b)

Arguments

$b

boolean

Should private members/classes be documented

setParseprivate($parseprivate)

Arguments

$parseprivate

Whether to use javadoc descriptions (more primitive).

setJavadocdesc($javadoc)

Arguments

$javadoc

Set (comma-separated) list of packages to output.

setPackageoutput(string $packages)

Arguments

$packages

string

Set (comma-separated) list of tags to ignore.

setIgnoretags(string $tags)

Arguments

$tags

string

Set a directory to search for examples in.

setExamplesdir(\PhingFile $d)

Arguments

$d

\PhingFile

Set a directory to search for configuration files in.

setConfigdir(\PhingFile $d)

Arguments

$d

\PhingFile

Sets the default package name.

setDefaultpackagename(string $name)

Arguments

$name

string

Sets the default category name.

setDefaultcategoryname(string $name)

Arguments

$name

string

Set whether to parse as PEAR repository.

setPear(boolean $b)

Arguments

$b

boolean

Creates a FileSet.

createFileset() : \FileSet

Response

\FileSet

Creates a readme/install/changelog fileset.

createProjdocfileset() : \FileSet

Response

\FileSet

Control whether or not warnings will be shown for undocumented elements.

setUndocumentedelements(boolean $b)

Useful for identifying classes and methods that haven't yet been documented.

Arguments

$b

boolean

custom tags, will be recognized and put in tags[] instead of unknowntags[].

setCustomtags(string $sCustomtags)

Arguments

$sCustomtags

string

Set base location of all templates for this parse.

setTemplateBase(\PhingFile $oTemplateBase)

Arguments

$oTemplateBase

\PhingFile

Set files to ignore

setIgnore(string $sIgnore)

Arguments

$sIgnore

string

Searches include_path for PhpDocumentor install and adjusts include_path appropriately.

findPhpDocumentorInstall()
throws
  • if unable to find PhpDocumentor on include_path

Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.

main()
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Validates that necessary minimum options have been set.

validate()
throws

if validation doesn't pass

Sets the options on the passed-in phpdoc setup object.

setPhpDocumentorOptions(\PhingPhpDocumentorSetup $phpdoc)

Arguments

$phpdoc

\PhingPhpDocumentorSetup

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Sets the type of the task. Usually this is the name of the XML tag

setTaskType($name)
inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO)
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)
inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

Called by the parser to let the task initialize properly.

init()
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location)
inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()
inherited

Perfrom this task

perform()
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Properties

Title for browser window / package index.

title : string
var

Title for browser window / package index.

Type(s)

string

The target directory for output files.

destdir : \PhingFile
var

The target directory for output files.

Type(s)

\PhingFile

FileSet[] Filesets for files to parse.

filesets : array
var

FileSet[] Filesets for files to parse.

Type(s)

array

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.

projDocFilesets : array
var

FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.

Type(s)

array

Package output format.

output : string
var

Package output format.

Type(s)

string

Whether to generate sourcecode for each file parsed.

linksource : boolean
var

Whether to generate sourcecode for each file parsed.

Type(s)

boolean

Whether to parse private members.

parsePrivate : boolean
var

Whether to parse private members.

Type(s)

boolean

Whether to use javadoc descriptions (more primitive).

javadocDesc : boolean
var

Whether to use javadoc descriptions (more primitive).

Type(s)

boolean

Base directory for locating template files.

templateBase : \PhingFile
var

Base directory for locating template files.

Type(s)

\PhingFile

Wheter to suppress output.

quiet : boolean
var

Wheter to suppress output.

Type(s)

boolean

Comma-separated list of packages to output.

packages : string
var

Comma-separated list of packages to output.

Type(s)

string

Comma-separated list of tags to ignore.

ignoreTags : string
var

Comma-separated list of tags to ignore.

Type(s)

string

Default package name.

defaultPackageName : string
var

Default package name.

Type(s)

string

Default category name.

defaultCategoryName : string
var

Default category name.

Type(s)

string

Directory in which to look for examples.

examplesDir : \PhingFile
var

Directory in which to look for examples.

Type(s)

\PhingFile

Directory in which to look for configuration files.

configDir : \PhingFile
var

Directory in which to look for configuration files.

Type(s)

\PhingFile

Whether to parse as a PEAR repository.

pear : boolean
var

Whether to parse as a PEAR repository.

Type(s)

boolean

Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented.

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.

Type(s)

boolean

custom tags, will be recognized and put in tags[] instead of unknowntags[].

customtags : string
var

custom tags, will be recognized and put in tags[] instead of unknowntags[].

Type(s)

string

files to ignore

ignore : string
var

files to ignore

Type(s)

string

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project