cvs: php4 /pear/PHPDoc/warning PhpdocWarning.php

uw Sun Feb 18 08:31:09 2001 EDT Modified files: /php4/pear/PHPDoc/warning PhpdocWarning.php Log: Sorry, whitespace only changes to follow the PEAR Coding conventions. Replaced tabs with spaces. Index: php4/pear/PHPDoc/warning/PhpdocWarning.php diff -u php4/pear/PHPDoc/warning/PhpdocWarning.php:1.2 php4/pear/PHPDoc/warning/PhpdocWarning.php:1.3 --- php4/pear/PHPDoc/warning/PhpdocWarning.php:1.2 Sun Dec 3 14:37:38 2000 +++ php4/pear/PHPDoc/warning/PhpdocWarning.php Sun Feb 18 08:31:09 2001 @@ -5,62 +5,65 @@ * The base of the report generator module is this container. It's currently * pretty simple and will change later on... * -* @version $Id: PhpdocWarning.php,v 1.2 2000/12/03 22:37:38 uw Exp $ +* @version $Id: PhpdocWarning.php,v 1.3 2001/02/18 16:31:09 uw Exp $ */ class PhpdocWarning extends PhpdocObject { - - /** - * Hash of documentation failures. - * @var array - */ - var $doc_warnings = array(); - - /** - * Counter containing the number of documentation warnings. - * @var integer - * @see getNumDocWarnings(), getNumWarnings() - */ - var $num_doc_warnings = 0; - - /** - * Adds a warning to the list of class documentation failures. - * @param string Name of the file that containts the error - * @param string Kind of the element that caused the error: module, class, function, variable, use, const - * @param string Name of the class/function/... that caused the warning - * @param string Warning message itself - * @param string Type of the error: missing, mismatch, syntax, ... - * @access public - * @see addDocWarning() - */ - function addDocWarning($file, $elementtype, $elementname, $warning, $type="missing") { + + /** + * Hash of documentation failures. + * + * @var array + */ + var $doc_warnings = array(); + + /** + * Counter containing the number of documentation warnings. + * + * @var integer + * @see getNumDocWarnings(), getNumWarnings() + */ + var $num_doc_warnings = 0; + + /** + * Adds a warning to the list of class documentation failures. + * + * @param string Name of the file that containts the error + * @param string Kind of the element that caused the error: module, class, function, variable, use, const + * @param string Name of the class/function/... that caused the warning + * @param string Warning message itself + * @param string Type of the error: missing, mismatch, syntax, ... + * @access public + * @see addDocWarning() + */ + function addDocWarning($file, $elementtype, $elementname, $warning, $type = "missing") { - $this->doc_warnings[$file][$elementtype][] = array( - "name" => $elementname, - "type" => $type, - "msg" => $warning - ); - $this->num_doc_warnings++; - - } // end func addDocWarning + $this->doc_warnings[$file][$elementtype][] = array( + "name" => $elementname, + "type" => $type, + "msg" => $warning + ); + $this->num_doc_warnings++; + + } // end func addDocWarning - /** - * Returns a list of warnings. - * - * @return array $warnings - * @access public - */ - function getWarnings() { - return $this->doc_warnings; - } // end func getParserWarnings - - /** - * Returns the total number of documentation warnings. - * @access public - * @see getNumParserWarnings(), getNumWarnings() - */ - function getNumDocWarnings() { - return $this->num_doc_warnings; - } // end func getNumDocWarnings - + /** + * Returns a list of warnings. + * + * @return array $warnings + * @access public + */ + function getWarnings() { + return $this->doc_warnings; + } // end func getParserWarnings + + /** + * Returns the total number of documentation warnings. + * @access public + * @see getNumParserWarnings(), getNumWarnings() + */ + function getNumDocWarnings() { + return $this->num_doc_warnings; + } // end func getNumDocWarnings + } // end class PhpdocWarning ?>