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

Class: parserDesc

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserDocBlock.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDesc

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


Author(s):

Version:

  • $Id$

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 {@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 47]
represents a short or long description in a DocBlock (parserDocBlock)
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • Copyright: 2002-2008 Gregory Beaver
  • Since: 1.0rc1


[ 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 ]



Method Detail

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 ]

hasInheritDoc   [line 81]

boolean hasInheritDoc( )

  • Return: whether this desc has an {@inheritdoc} inline tag

[ Top ]

hasSource   [line 92]

boolean hasSource( )

  • Return: whether this desc has an {@source} inline tag

[ Top ]

replaceInheritDoc   [line 104]

void replaceInheritDoc( parserDesc $desc)

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

Parameters:

parserDesc   $desc     parent parserDesc, used to retrieve the description

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:35 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.