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

Class: parserDefine

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserDefine



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

[line 1983]


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


method getConflicts [line 2011]

mixed getConflicts( Converter &$c)

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 ]

method getLink [line 1997]

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

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 ]


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