tasks/ext/phpdoc/PhingPhpDocumentorSetup.php

Show: inherited
Table of Contents

\PhingPhpDocumentorSetup

Package: phing\tasks\ext\phpdoc

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 @author hans  
Version
$Id: cde99d501839daf8c9dd9df61ee6cce7caad6b3e $  

Methods

methodpublic__construct(  $configdir = null, object $task ) : void

Constructs a new PhingPhpDocumentorSetup.

Parameters
Name Type Description
$configdir
$task object

The task we're working with, so we can pass it on to the ErrorTracker

methodpublicsetCustomtags( string $sCustomtags ) : void

custom 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.

Parameters
Name Type Description
$sCustomtags string
methodpublicsetDefaultCategoryName( string $name ) : void

Sets 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.

Parameters
Name Type Description
$name string
methodpublicsetDefaultPackageName( string $name ) : void

Sets 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.

Parameters
Name Type Description
$name string
methodpublicsetExamplesDir( string $dir ) : void

Set 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.

Parameters
Name Type Description
$dir string
methodpublicsetGenerateSourcecode( bool $b ) : void

Set 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.

Parameters
Name Type Description
$b bool
methodpublicsetIgnore( string $sIgnore ) : void

Files to ignore

Parameters
Name Type Description
$sIgnore string
methodpublicsetIgnoreTags( string $tags ) : void

Set 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.

Parameters
Name Type Description
$tags string
methodpublicsetPear( bool $b ) : void

Set 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.

Parameters
Name Type Description
$b bool
methodpublicsetQuietMode( ) : void

Enables 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.

methodpublicsetRicFiles( array $files ) : void

Set 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.

Parameters
Name Type Description
$files array

Absolute paths to files.

methodpublicsetUndocumentedelements( bool $bEnable ) : void

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

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

Parameters
Name Type Description
$bEnable bool
Documentation was generated by DocBlox 0.18.1.