tasks/ext/phpdoc/PhingPhpDocumentorSetup.php
inherited
Classes
\PhingPhpDocumentorSetup
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.
- Parent(s)
- \phpDocumentor_setup
- Author
- Hans Lellelid
- Version
- $Id: cde99d501839daf8c9dd9df61ee6cce7caad6b3e $
Methods
__construct(
$configdir
=
null, object $task
)
:
voidConstructs a new PhingPhpDocumentorSetup.
| Name | Type | Description |
|---|---|---|
| $configdir | ||
| $task | object | The task we're working with, so we can pass it on to the ErrorTracker |
setCustomtags(
string $sCustomtags
)
:
voidcustom tags, will be recognized and put in tags[] instead of unknowntags[]
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.
| Name | Type | Description |
|---|---|---|
| $sCustomtags | string |
setDefaultCategoryName(
string $name
)
:
voidSets the default category 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.
| Name | Type | Description |
|---|---|---|
| $name | string |
setDefaultPackageName(
string $name
)
:
voidSets the default package 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.
| Name | Type | Description |
|---|---|---|
| $name | string |
setExamplesDir(
string $dir
)
:
voidSet fullpath to directory to look in for examples.
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.
| Name | Type | Description |
|---|---|---|
| $dir | string |
setGenerateSourcecode(
bool $b
)
:
voidSet whether to generate sourcecode for each file parsed.
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.
| Name | Type | Description |
|---|---|---|
| $b | bool |
setIgnore(
string $sIgnore
)
:
voidFiles to ignore
| Name | Type | Description |
|---|---|---|
| $sIgnore | string |
setIgnoreTags(
string $tags
)
:
voidSet comma-separated list of tags to ignore.
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.
| Name | Type | Description |
|---|---|---|
| $tags | string |
setPear(
bool $b
)
:
voidSet whether to parse dirs as PEAR repos.
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.
| Name | Type | Description |
|---|---|---|
| $b | bool |
setQuietMode(
)
:
voidEnables quiet mode.
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.
setRicFiles(
array $files
)
:
voidSet an array of README/INSTALL/CHANGELOG file paths.
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.
| Name | Type | Description |
|---|---|---|
| $files | array | Absolute paths to files. |
setUndocumentedelements(
bool $bEnable
)
:
voidControl whether or not warnings will be shown for undocumented elements.
Useful for identifying classes and methods that haven't yet been documented.
| Name | Type | Description |
|---|---|---|
| $bEnable | bool |