phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserMethodTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview

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

represents the "@method" tag


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables


Inherited Variables

Inherited Methods

Class: parserPropertyTag

parserPropertyTag::parserPropertyTag()
set up the property tag

Class: parserReturnTag

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

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.

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

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

Class Details

[line 545]
represents the "@method" tag



Tags:

tutorial:  @method
author:  Greg Beaver <cellog@php.net>
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_*
since:  1.4.0a1
license:  LGPL


[ Top ]


Class Variables

$keyword =  'method'

[line 551]

always 'method'


Type:   string
Overrides:   Array


[ Top ]

$returnType =  'void'

[line 556]

the return type a method has


Type:   string
Overrides:   Array


[ Top ]



Documentation generated on Tue, 06 Dec 2011 07:11:59 -0600 by phpDocumentor 1.4.4