Docs For Class parserDefine

Description

parserBase
   |
   --parserElement
      |
      --parserDefine

Located in File: /phpDocumentor/ParserElements.inc

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

Class Variables

Summary:

string $type

$type = 'define' (line 1989)

Data type : string

Overrides: Array

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

var: - always 'define'

Class Constants

Summary:

Method Detail

Summary:

mixed getConflicts (Converter &$c)

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

Method getConflicts (line 2011)

mixed getConflicts( Converter &$c)

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

Parameters

Converter &$c:

Info

return - false or an array Format: (package => parserDefine of conflicting defines)
usedby - Converter::getFormattedConflicts()

Method getLink (line 1997)

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

quick way to link to this element

Parameters

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

Info

return - converter-specific link to this define

Class parserDefine

Description

Class Variables

$type = 'define' (line 1989)

Data type : string

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

Class Constants

Method Detail

Method getConflicts (line 2011)

mixed getConflicts( Converter &$c)

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

Parameters

Info

Method getLink (line 1997)

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

quick way to link to this element

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserElement

parserElement::$conflicts -

parserElement::$docblock -

parserElement::$endlinenumber - line number on file where this element stops

parserElement::$file - location of this element (filename)

parserElement::$linenumber - Line number in the source on which this element appears

parserElement::$name - name of this element, or include type if element is a parserInclude

parserElement::$path - full path location of this element (filename)

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class parserElement

parserElement::getEndLineNumber() -

parserElement::getFile() -

parserElement::getLineNumber() -

parserElement::getName() -

parserElement::getPackage() -

parserElement::getPath() -

parserElement::setDocBlock() -

parserElement::setEndLineNumber() - Sets the ending line number of elements

parserElement::setFile() -

parserElement::setLineNumber() - Set starting line number

parserElement::setName() -

parserElement::setPath() -

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value