Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/warning/PhpdocWarning.php
PEAR Repository - PHPDoc

PhpdocWarning

PhpdocObject
   |
  +-- PhpdocWarning

Container for all kind of Warnings the parser/analyser recognizes

The base of the report generator module is this container. It's currently
pretty simple and will change later on...

 

private class PhpdocWarning extends PhpdocObject

Container for all kind of Warnings the parser/analyser recognizes

The base of the report generator module is this container. It's currently
pretty simple and will change later on...

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0beta

 

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

addDocWarning(string $file, string $elementtype, string $elementname, string $warning, string $type)

Adds a warning to the list of class documentation failures.
array

getWarnings()

Returns a list of warnings.
void

getNumDocWarnings()

Returns the total number of documentation warnings.

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$doc_warnings

Hash of documentation failures.
integer

$num_doc_warnings

Counter containing the number of documentation warnings.

Public Method Details

addDocWarning

public void addDocWarning( string $file, string $elementtype, string $elementname, string $warning, string $type )

  Adds a warning to the list of class documentation failures.

Parameter
string $file
Name of the file that containts the error
string $elementtype
Kind of the element that caused the error: module, class, function, variable, use, const
string $elementname
Name of the class/function/... that caused the warning
string $warning
Warning message itself
@para, string Type of the error: missing, mismatch, syntax, ...
string $type
Returns void

See Also addDocWarning()

getWarnings

public array getWarnings( )

  Returns a list of warnings.

Returns array $warnings


getNumDocWarnings

public void getNumDocWarnings( )

  Returns the total number of documentation warnings.

Returns void

See Also getNumParserWarnings(), getNumWarnings()

Private Field Details

$doc_warnings

private array $doc_warnings

>>array()<<


$num_doc_warnings

private integer $num_doc_warnings

>><<

See Also getNumDocWarnings(), getNumWarnings()


Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta