Class parserDefine

Description
Variable Summary
string $type
Method Summary
mixed getConflicts (Converter &$c)
mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])
Variables
string $type = 'define' (line 1989)

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

  • var: always 'define'

Redefinition of:
parserBase::$type
Type is used by many functions to skip the hassle of if

Inherited Variables

Inherited from parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$endlinenumber
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Inherited from parserBase

parserBase::$value
Methods
getConflicts (line 2011)

Returns all defines in other packages that have the same name as this define

mixed getConflicts (Converter &$c)
getLink (line 1997)

quick way to link to this element

  • return: converter-specific link to this define
mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])
  • Converter $c
  • string $text: text to display for the link or false for default text
  • $returnobj

Inherited Methods

Inherited From parserElement

parserElement::getEndLineNumber()
parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setEndLineNumber()
parserElement::setFile()
parserElement::setLineNumber()
parserElement::setName()
parserElement::setPath()

Inherited From parserBase

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

Documentation generated on Mon, 05 Dec 2011 21:11:57 -0600 by phpDocumentor 1.4.4