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

Class: parserDesc

Source Location: /phpDocumentor/ParserDocBlock.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDesc

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


Author(s):

Version:

  • $Id: ParserDocBlock.inc 287886 2009-08-30 05:31:05Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods

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



[ Top ]


Class Variables

$type =  '_desc'

[line 54]

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

always '_desc'



Type:   string
Overrides:   Array


[ Top ]



Class Methods


method add [line 60]

void add( mixed $stringOrClass)



Overrides parserStringWithInlineTags::add() (equivalent to the . operator ($a = $b . $c))

Parameters:

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

[ Top ]

method hasInheritDoc [line 81]

boolean hasInheritDoc( )



Tags:

return:  whether this desc has an [email protected]} inline tag


[ Top ]

method hasSource [line 92]

boolean hasSource( )



Tags:

return:  whether this desc has an [email protected]} inline tag


[ Top ]

method replaceInheritDoc [line 104]

void replaceInheritDoc( parserDesc $desc)

replaces [email protected]} with the contents of the parent DocBlock



Parameters:

parserDesc   $desc   parent parserDesc, used to retrieve the description

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:29 -0600 by phpDocumentor 1.4.4