+++ /dev/null
-<?php\r
-/**\r
-* Container for all kind of Warnings the parser/analyser recognizes\r
-* \r
-* The base of the report generator module is this container. It's currently \r
-* pretty simple and will change later on...\r
-*\r
-* @version $Id: PhpdocWarning.php,v 1.2 2000/12/03 22:37:38 uw Exp $\r
-*/\r
-class PhpdocWarning extends PhpdocObject {\r
- \r
- /**\r
- * Hash of documentation failures.\r
- * @var array \r
- */\r
- var $doc_warnings = array();\r
- \r
- /**\r
- * Counter containing the number of documentation warnings.\r
- * @var integer\r
- * @see getNumDocWarnings(), getNumWarnings()\r
- */\r
- var $num_doc_warnings = 0;\r
- \r
- /**\r
- * Adds a warning to the list of class documentation failures.\r
- * @param string Name of the file that containts the error\r
- * @param string Kind of the element that caused the error: module, class, function, variable, use, const\r
- * @param string Name of the class/function/... that caused the warning\r
- * @param string Warning message itself\r
- * @param string Type of the error: missing, mismatch, syntax, ...\r
- * @access public\r
- * @see addDocWarning()\r
- */\r
- function addDocWarning($file, $elementtype, $elementname, $warning, $type="missing") {\r
-\r
- $this->doc_warnings[$file][$elementtype][] = array(\r
- "name" => $elementname,\r
- "type" => $type,\r
- "msg" => $warning\r
- );\r
- $this->num_doc_warnings++;\r
- \r
- } // end func addDocWarning\r
-\r
- /**\r
- * Returns a list of warnings.\r
- *\r
- * @return array $warnings\r
- * @access public\r
- */ \r
- function getWarnings() {\r
- return $this->doc_warnings;\r
- } // end func getParserWarnings\r
- \r
- /**\r
- * Returns the total number of documentation warnings.\r
- * @access public\r
- * @see getNumParserWarnings(), getNumWarnings()\r
- */\r
- function getNumDocWarnings() {\r
- return $this->num_doc_warnings;\r
- } // end func getNumDocWarnings\r
- \r
-} // end class PhpdocWarning\r
-?>
\ No newline at end of file