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

Class: parserConst

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserConst



Author(s):

Version:

  • $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details



[ Top ]


Class Variables

$class =  ''

[line 1586]



Tags:

var:  class that contains this var

Type:   string


[ 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


constructor parserConst [line 1591]

parserConst parserConst( string $class)



Parameters:

string   $class  

[ Top ]

method getClass [line 1600]

string getClass( )

Retrieve the class name



Tags:

return:  Class name that this var belongs to


[ Top ]

method getLink [line 1611]

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

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 ]


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