| // +----------------------------------------------------------------------+ // /** * Phpdoc data container * * @package PHP_CodeDoc * @access public * @author Alan Knowles * */ class PHP_CodeDoc_Data_PhpDoc { var $long = ""; // name of parameter var $short = ""; // default value var $original; // original text of comment var $param = array(); //@param type $varname description var $return; //@return type description var $access; //@access public or private var $author; //@author author name var $copyright; //@copyright name date var $version; //@version version var $see; //@see name of another element that can be documented, produces a link to it in the documentation var $link; //@link a url var $since; //@since a version or a date var $deprecacted; //@deprecated|@deprec description var $magic; //@magic phpdoc.de compatibility var $todo; //@todo phpdoc.de compatibility var $exception; //@exception Javadoc-compatible, use as needed var $throws; //@throws Javadoc-compatible, use as needed var $var; //@var type a data type for a class variable var $package; //@package package name var $subpackage; //@subpackage sub package name, groupings inside of a project function __construct() { $this->return = new stdClass(); $this->return->type = ''; $this->return->desc= ''; } function longToHTML() { $ret = '

'. $this->long .'

'; $ret = preg_replace('/\n\s+\n/','

',$ret); return $ret; } }