Class: parserDefine

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 1983]

parserBase
   |
   --parserElement
      |
      --parserDefine

Author(s):

Version:

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

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods




Class Details

Tags:

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

Parameters:

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


Class Constants


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