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

Class: parserDefine

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserDefine



Author(s):

Version:

  • $Id$

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 1993]
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • Copyright: 2002-2008 Gregory Beaver
  • Since: 1.0rc1


[ Top ]


Class Variables

$type =  'define'

[line 1999]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

getConflicts   [line 2021]

mixed getConflicts( Converter &$c)

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

Parameters:

Converter   &$c     

[ Top ]

getLink   [line 2007]

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

quick way to link to this element
  • 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 Sun, 02 Sep 2012 00:02:40 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.