CodeDoc/Data/PhpDoc.php

diff --git a/CodeDoc/Data/PhpDoc.php b/CodeDoc/Data/PhpDoc.php
new file mode 100644 (file)
index 0000000..2be5b0c
--- /dev/null
+++ b/CodeDoc/Data/PhpDoc.php
@@ -0,0 +1,69 @@
+<?php
+
+// +----------------------------------------------------------------------+
+// | PHP Version 4                                                        |
+// +----------------------------------------------------------------------+
+// | Copyright (c) 1997-2002 The PHP Group                                |
+// +----------------------------------------------------------------------+
+// | This source file is subject to version 2.02 of the PHP license,      |
+// | that is bundled with this package in the file LICENSE, and is        |
+// | available at through the world-wide-web at                           |
+// | http://www.php.net/license/2_02.txt.                                 |
+// | If you did not receive a copy of the PHP license and are unable to   |
+// | obtain it through the world-wide-web, please send a note to          |
+// | license@php.net so we can mail you a copy immediately.               |
+// +----------------------------------------------------------------------+
+// | Authors: Alan Knowles <alan@akbkhome.com>                      |
+// +----------------------------------------------------------------------+
+//
+
+/**
+*   Phpdoc data container
+*
+*   @package  PHP_CodeDoc
+*   @access   public
+*   @author   Alan Knowles <alan@akbkhome.com>
+*
+*/
+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 = '<p>'. $this->long .'</p>';
+        $ret = preg_replace(/\n\s+\n/,'</p><p>',$ret);
+        
+        
+        
+        
+    }
+    
+}
+ 
\ No newline at end of file