PHPDOC 2000/12/03 - PHPDoc

PhpdocWarning

PhpdocObject
|
+-- PhpdocWarning

Container for all kind of Warnings the parser/analyser recognizes

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 currentlypretty simple and will change later on...

Authors Ulf Wendel <ulf.wendel@phpdoc.de>

Version $Id: $

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, $application, $warn, $flag_output

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
	of the file that containts the error

string	$elementtype
	of the element that caused the error: module, class, function, variable, use, const

string	$elementname
	of the class/function/... that caused the warning

string	$warning
	message itself

string	$type	`= >>"missing"<<`
	of the error: missing, mismatch, syntax, ...

Returns

void

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

Private Field Details
$doc_warnings
private array $doc_warnings >>`array()`<< Hash of documentation failures.

$num_doc_warnings
private integer $num_doc_warnings >><< Counter containing the number of documentation warnings.
See Also	getNumDocWarnings()