tasks/ext/phpdoc/PhingPhpDocumentorSetup.php

Show:

inherited

Classes
- \PhingPhpDocumentorSetup

Table of Contents

$Id: PhingPhpDocumentorSetup.php 1108 2011-05-23 15:01:31Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

\PhingPhpDocumentorSetup
jump to top

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: PhingPhpDocumentorSetup.php 1108 2011-05-23 15:01:31Z mrook $

Methods

__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

setCustomtags(
          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

setDefaultCategoryName(
          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

setDefaultPackageName(
          string $name
          )
        
        :
          void

Sets the default package name.

Parameters

Name	Type	Description
$name	string

setExamplesDir(
          string $dir
          )
        
        :
          void

Set fullpath to directory to look in for examples.

Parameters

Name	Type	Description
$dir	string

setGenerateSourcecode(
          bool $b
          )
        
        :
          void

Set whether to generate sourcecode for each file parsed.

Parameters

Name	Type	Description
$b	bool

setIgnore(
          string $sIgnore
          )
        
        :
          void

Files to ignore

Parameters

Name	Type	Description
$sIgnore	string

setIgnoreTags(
          string $tags
          )
        
        :
          void

Set comma-separated list of tags to ignore.

Parameters

Name	Type	Description
$tags	string

setPear(
          bool $b
          )
        
        :
          void

Set whether to parse dirs as PEAR repos.

Parameters

Name	Type	Description
$b	bool

setQuietMode(
          
          )
        
        :
          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.

setRicFiles(
          array $files
          )
        
        :
          void

Set an array of README/INSTALL/CHANGELOG file paths.

Parameters

Name	Type	Description
$files	array	Absolute paths to files.

setUndocumentedelements(
          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

tasks/ext/phpdoc/PhingPhpDocumentorSetup.php

\PhingPhpDocumentorSetupjump to top

Methods

\PhingPhpDocumentorSetup
jump to top