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

Class: parserReturnTag

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

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag

represents "@return"


Author(s):

Version:

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

Variables

Methods


Child classes:

parserPropertyTag
represents "@property" tag
parserVarTag
represents "@var"

Inherited Variables

Inherited Methods

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 278]
represents "@return"
  • Tutorial: @return
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id: DocBlockTags.inc,v 1.10 2007/04/19 20:20:57 ashnazg Exp $
  • Since: 1.0rc1


[ Top ]


Class Variables

$converted_returnType =  false

[line 308]

contains a link to the documentation for a class passed as a type in @return, @var or @param

Example:

  1.  class myclass
  2.  {
  3.  ...
  4.  }
  5.  

In this case, $converted_returnType will contain a link to myclass instead of the string 'myclass'


Type:   mixed


[ Top ]

$keyword =  'return'

[line 284]

always 'return'

Type:   string
Overrides:   Array


[ Top ]

$returnType =  'void'

[line 288]

the type a function returns

Type:   mixed


[ Top ]



Method Detail

parserReturnTag (Constructor)   [line 314]

parserReturnTag parserReturnTag( string $returnType, parserStringWithInlineTags $value)


Parameters:

string   $returnType     
parserStringWithInlineTags   $value     

[ Top ]

Convert   [line 326]

string Convert( Converter &$converter)

sets up $converted_returnType

Overrides parserTag::Convert() (parent method not documented)

Parameters:

Converter   &$converter     

[ Top ]


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