tasks/ext/phpdoc/PhingPhpDocumentorErrorTracker.php

Show: inherited
Table of Contents

\PhingPhpDocumentorErrorTracker

Package: phing\tasks\ext\phpdoc

Phing subclass of the ErrorTracker class provided with PhpDocumentor to work around limitations in PhpDocumentor API.

This class is necessary because PhpDocumentor does directly output errors and warnings occured during testing for undocumented elements to stdout. This class is injected globally to force PhpDocumentor to use phing's logging mechanism.

Obviously this is far from ideal, but there's also no solution given the inflexibility of the PhpDocumentor design.

Parent(s)
\ErrorTracker
Author
Timo A. Hummel @author felicitus  
Version
$Id: 73c919ab2044bf6582f52bd7ccb0184019d52f53 $  

Properties

Propertyprivate  $task= ''
Details
Type
n/a

Methods

methodpublicaddError( \$num $num ) : \nothing

Outputs an error. This is an almost 1:1 copy from PhpDocumentor, we're just processing the error text and send it to phing's logger.

Parameters
Name Type Description
$num \$num

integer Number of parameters

Returns
Type Description
\nothing
methodpublicaddWarning( \$num $num ) : \nothing

Outputs a warning. This is an almost 1:1 copy from PhpDocumentor, we're just processing the warning text and send it to phing's logger.

Parameters
Name Type Description
$num \$num

integer Number of parameters

Returns
Type Description
\nothing
methodpublicsetTask( object $task ) : \nothing

Sets the task we're working with. This is necessary since we need to be able to call the method "log".

Parameters
Name Type Description
$task object

The task we're working with

Returns
Type Description
\nothing
Documentation was generated by DocBlox 0.18.1.