Description

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag
            |
            --parserVarTag
               |
               --parserParamTag

Located in File: /phpDocumentor/DocBlockTags.inc

represents the "@param" tag

• tutorial: - @param
• author: - Greg Beaver <[email protected]>
• version: - Release: @VER@
• copyright: - 2002-2008 Gregory Beaver
• link: - http://pear.php.net/PhpDocumentor
• link: - http://www.phpdoc.org
• todo: - CS cleanup - change package to PhpDocumentor
• todo: - CS cleanup - change classname to PhpDocumentor_*
• license: - LGPL

---

Classes extended from parserParamTag:

parserStaticvarTag

represents the "@staticvar" tag

Class Variables

Summary:

---

Class Constants

Summary:

---

Method Detail

Summary:

---

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserVarTag

parserVarTag::$returnType - the type a var has

Inherited From Class parserReturnTag

parserReturnTag::$converted_returnType - contains a link to the documentation for a class passed as a type in @return, @var or @param

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserReturnTag

parserReturnTag::parserReturnTag() - set up the tag

parserReturnTag::Convert() - process this tag through the given output converter (sets up the $converted_returnType)

Inherited From Class parserTag

parserTag::parserTag() - Set up the tag

parserTag::Convert() - Perform the output conversion on this parserTag using the output converter that is passed in

parserTag::getString() - Returns the text minus any inline tags

parserTag::HandleEvent() - Called by the parserDescParser when processing a description.

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::add() - equivalent to the . operator ($a = $b . $c)

parserStringWithInlineTags::Convert() - Use to convert the string to a real string with all inline tags parsed and linked

parserStringWithInlineTags::getString() - return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)

parserStringWithInlineTags::hasInlineTag() - Determine whether the string contains any inline tags

parserStringWithInlineTags::setSource() - Pass source code to any {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen() - equivalent to trim(strlen($string))

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value