Inherited Methods
Class: parserElement
- parserElement::getEndLineNumber()
- parserElement::getFile()
- parserElement::getLineNumber()
- parserElement::getName()
- parserElement::getPackage()
- parserElement::getPath()
- parserElement::setDocBlock()
- parserElement::setEndLineNumber()
- Sets the ending line number of elements
- parserElement::setFile()
- parserElement::setLineNumber()
- Set starting line number
- parserElement::setName()
- parserElement::setPath()
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
Tags:
- author - Greg Beaver <[email protected]>
- version - $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
- copyright - 2002-2008 Gregory Beaver
- since - 1.0rc1
[ Top ]
Class Variables
$type = 'define'
[line 1989]
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
Tags:
- var - always 'define'
Type: string
Overrides: Array
[ Top ]
Class Methods
getConflicts
mixed getConflicts(
Converter
&$c)
[line 2011]
Returns all defines in other packages that have the same name as this define
Tags:
- return - false or an array Format: (package => parserDefine of conflicting defines)
- usedby - Converter::getFormattedConflicts()
Parameters:
- Converter &$c -
[ Top ]
getLink
mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])
[line 1997]
quick way to link to this element
Tags:
- return - converter-specific link to this define
Parameters:
- Converter $c -
- string $text - text to display for the link or false for default text
- $returnobj -
[ Top ]