phpDocumentor

[ ] [ ] [ ]

Class: parserMethodTag

Source Location: /PhpDocumentor-1.4.0RC1/phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag
            |
            --parserPropertyTag
               |
               --parserMethodTag

represents "@method" tag

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

Variables

Inherited Variables

Class: parserReturnTag

parserReturnTag::$converted_returnType

Class: parserTag

parserTag::$type

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserPropertyTag

parserPropertyTag::parserPropertyTag()

Class: parserReturnTag

parserReturnTag::parserReturnTag()
parserReturnTag::Convert(): sets up $converted_returnType

Class: parserTag

parserTag::parserTag(): Set up the tag
parserTag::Convert()
parserTag::getString()
parserTag::HandleEvent(): Called by the parserDescParser when processing a description.

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
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))

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 423]
represents "@method" tag

Author: Greg Beaver <cellog@php.net>
Version: $Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $

[ Top ]

Class Variables

$keyword = 'method'

[line 429]

always 'method'

Type:	string
Overrides:	Array

[ Top ]

$returnType = 'void'

[line 434]

the return type a method has

Type:	string
Overrides:	Array

[ Top ]

Documentation generated on Mon, 25 Jun 2007 14:02:16 -0400 by phpDocumentor 1.3.2. PEAR Logo Copyright © PHP Group 2004.