git.roojs.org Git - PHP_CodeDoc/blob - CodeDoc/Data/PhpDoc.php

   1 <?php
   2
   3 // +----------------------------------------------------------------------+
   4 // | PHP Version 4                                                        |
   5 // +----------------------------------------------------------------------+
   6 // | Copyright (c) 1997-2002 The PHP Group                                |
   7 // +----------------------------------------------------------------------+
   8 // | This source file is subject to version 2.02 of the PHP license,      |
   9 // | that is bundled with this package in the file LICENSE, and is        |
  10 // | available at through the world-wide-web at                           |
  11 // | http://www.php.net/license/2_02.txt.                                 |
  12 // | If you did not receive a copy of the PHP license and are unable to   |
  13 // | obtain it through the world-wide-web, please send a note to          |
  14 // | license@php.net so we can mail you a copy immediately.               |
  15 // +----------------------------------------------------------------------+
  16 // | Authors: Alan Knowles <alan@akbkhome.com>                      |
  17 // +----------------------------------------------------------------------+
  18 //
  19
  20 /**
  21 *   Phpdoc data container
  22 *
  23 *   @package  PHP_CodeDoc
  24 *   @access   public
  25 *   @author   Alan Knowles <alan@akbkhome.com>
  26 *
  27 */
  28 class PHP_CodeDoc_Data_PhpDoc {
  29     var $long = "";             // name of parameter
  30     var $short = "";            // default value
  31     var $original;              // original text of comment
  32     var $param = array();       //@param        type    $varname        description
  33     var $return;                //@return       type    description
  34     var $access;                //@access       public or private
  35     var $author;                //@author       author name
  36     var $copyright;             //@copyright    name date
  37     var $version;               //@version      version
  38     var $see;                   //@see          name of another element that can be documented, produces a link to it in the documentation
  39     var $link;                  //@link         a url
  40     var $since;                 //@since        a version or a date
  41     var $deprecacted;           //@deprecated|@deprec   description
  42     var $magic;                 //@magic                 phpdoc.de compatibility
  43     var $todo;                  //@todo         phpdoc.de compatibility
  44     var $exception;             //@exception    Javadoc-compatible, use as needed
  45     var $throws;                //@throws       Javadoc-compatible, use as needed
  46     var $var;                   //@var          type    a data type for a class variable
  47     var $package;               //@package      package name
  48
  49     var $subpackage;            //@subpackage   sub package name, groupings inside of a project
  50
  51     function __construct()
  52     {
  53         $this->return = new stdClass();
  54         $this->return->type = '';
  55         $this->return->desc= '';
  56     }
  57
  58     function longToHTML()
  59     {
  60         $ret = '<p>'. $this->long .'</p>';
  61         $ret = preg_replace(/\n\s+\n/,'</p><p>',$ret);
  62
  63
  64
  65
  66     }
  67
  68 }
  69