Class: parserConst

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 1578]

parserBase
   |
   --parserElement
      |
      --parserConst

Variables

Constants

Methods




Class Details

Tags:

[ Top ]


Class Variables

$class =  ''

[line 1586]

Tags:

  • var - class that contains this var

Type: string

Overrides:

[ Top ]

$type =  'const'

[line 1584]

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

Tags:

  • var - always 'const'

Type: string

Overrides: Array

[ Top ]


Class Methods

parserConst

parserConst parserConst( string $class)

[line 1591]

Parameters:

  • string $class -

[ Top ]

getClass

string getClass( )

[line 1600]

Retrieve the class name

Tags:

  • return - Class name that this var belongs to

Parameters:

[ Top ]

getLink

mixed getLink( Converter $c, [string $text = false], [ $returnobj = false])

[line 1611]

quick way to link to this element

Tags:

  • return - converter-specific link to this var

Parameters:

  • Converter $c -
  • string $text - text to display for the link or false for default text
  • $returnobj -

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:19 -0600 by phpDocumentor 1.4.4