Phing subclass of the phpDocumentor_setup class provided with PhpDocumentor to work around limitations in PhpDocumentor API.
This class is necessary because phpDocumentor_setup does not expose a complete API for setting configuration options. Because this class must directly modify some "private" GLOBAL(!) configuration variables, it is liable to break if the PhpDocumentor internal implementation changes. Obviously this is far from ideal, but there's also no solution given the inflexibility of the PhpDocumentor design.
author |
Hans Lellelid hans@xmpl.org@author hans |
---|---|
version |
$Id: cde99d501839daf8c9dd9df61ee6cce7caad6b3e $ |
package |
phing.tasks.ext.phpdoc |
__construct($configdir = null, object $task)
object
The task we're working with, so we can pass it on to the ErrorTracker
setGenerateSourcecode(bool $b)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
bool
setRicFiles(array $files)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
array
Absolute paths to files.
setIgnoreTags(string $tags)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
string
setPear(bool $b)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
bool
setExamplesDir(string $dir)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
string
setDefaultPackageName(string $name)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
string
setDefaultCategoryName(string $name)
This method exists as a hack because there is no API exposed for this in PhpDocumentor. Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
string
setQuietMode()
This method exists as a hack because the API exposed for this method in PhpDocumentor doesn't work correctly.
Note that because we are setting a "private" GLOBAL(!!) config var with this value, this is subject to break if PhpDocumentor internals changes.
setUndocumentedelements(bool $bEnable)
Useful for identifying classes and methods that haven't yet been documented.
bool
setIgnore(string $sIgnore)
string