From f25b7e3b54389cec8be505a054452b250398c1db Mon Sep 17 00:00:00 2001 From: Alan Knowles Date: Thu, 13 Oct 2016 16:04:45 +0800 Subject: [PATCH] CodeDoc/Data/PhpDoc.php --- CodeDoc/Data/PhpDoc.php | 69 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 CodeDoc/Data/PhpDoc.php diff --git a/CodeDoc/Data/PhpDoc.php b/CodeDoc/Data/PhpDoc.php new file mode 100644 index 0000000..2be5b0c --- /dev/null +++ b/CodeDoc/Data/PhpDoc.php @@ -0,0 +1,69 @@ + | +// +----------------------------------------------------------------------+ +// + +/** +* 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); + + + + + } + +} + \ No newline at end of file -- 2.39.2