Class parserDesc

Description

represents a short or long description in a DocBlock (parserDocBlock)

  • author: Greg Beaver <cellog@php.net>
  • version: $Id: ParserDocBlock.inc 287886 2009-08-30 05:31:05Z ashnazg $
  • copyright: 2002-2008 Gregory Beaver
  • since: 1.0rc1

Located in /phpDocumentor/ParserDocBlock.inc (line 47)

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDesc
Variable Summary
string $type
Method Summary
void add (mixed $stringOrClass)
boolean hasInheritDoc ()
boolean hasSource ()
Variables
string $type = '_desc' (line 54)

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

always '_desc'


Redefinition of:
parserStringWithInlineTags::$type
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...

Inherited Variables

Inherited from parserStringWithInlineTags

parserStringWithInlineTags::$value
Methods
add (line 60)
void add (mixed $stringOrClass)
  • mixed $stringOrClass: like parserStringWithInlineTags::add(), this can be a string or parserInlineTag, but it can also be a parserStringWithInlineTags, and the contents will be merged

Redefinition of:
parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
hasInheritDoc (line 81)
  • return: whether this desc has an {@inheritdoc} inline tag
boolean hasInheritDoc ()
hasSource (line 92)
  • return: whether this desc has an {@source} inline tag
boolean hasSource ()
replaceInheritDoc (line 104)

replaces {@inheritdoc} with the contents of the parent DocBlock

void replaceInheritDoc (parserDesc $desc)
  • parserDesc $desc: parent parserDesc, used to retrieve the description

Inherited Methods

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
parserStringWithInlineTags::Convert()
parserStringWithInlineTags::getString()
parserStringWithInlineTags::hasInlineTag()
parserStringWithInlineTags::setSource()
parserStringWithInlineTags::trimmedStrlen()

Inherited From parserBase

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

Documentation generated on Mon, 05 Dec 2011 21:51:02 -0600 by phpDocumentor 1.4.4