Class: parserReturnTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview [line 341]

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

Variables

Constants

Methods


Child classes:

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

Inherited Variables

Inherited Constants

Inherited Methods

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 [email protected]} 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

represents the "@return" tag

Tags:

[ Top ]


Class Variables

$converted_returnType =  false

[line 374]

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.  /** @return myclass blahblahblah
  6.  ...

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

Tags:

Type: mixed

Overrides:

[ Top ]

$keyword =  'return'

[line 347]

always 'return'

Type: string

Overrides: Array

[ Top ]

$returnType =  'void'

[line 351]

the type a function returns

Type: mixed

Overrides:

[ Top ]


Class Methods

parserReturnTag

parserReturnTag parserReturnTag( string $returnType, parserStringWithInlineTags $value)

[line 382]

set up the tag

Parameters:

[ Top ]

Convert

string Convert( Converter &$converter)

[line 398]

process this tag through the given output converter (sets up the $converted_returnType)

Tags:

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

Parameters:

  • Converter &$converter - the output converter

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:05:43 -0600 by phpDocumentor 1.4.4