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

Class: parserBase

Source Location: /phpDocumentor/ParserData.inc

Class Overview


Base class for all elements


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Child classes:

parserInlineTag
Use this element to represent an {@inline tag} like {@link}
parserStringWithInlineTags
Used to represent strings that contain inline tags, so that they can be properly parsed at link time
parserElement
all elements except parserPackagePage descend from this abstract class

Class Details

[line 710]
Base class for all elements



Tags:

author:  Gregory Beaver <cellog@php.net>
version:  Release: @VER@
copyright:  2002-2008 Gregory Beaver
link:  http://pear.php.net/PhpDocumentor
link:  http://www.phpdoc.org
todo:  CS cleanup - change package to PhpDocumentor
abstract:  
since:  1.0rc1
license:  LGPL


[ Top ]


Class Variables

$type =  'base'

[line 717]

Type is used by many functions to skip the hassle of if

phpDocumentor_get_class($blah) == 'parserBlah'... always base



Type:   string


[ Top ]

$value =  false

[line 723]

set to different things by its descendants



Tags:

abstract:  

Type:   mixed


[ Top ]



Class Methods


method getType [line 730]

string getType( )

gets the type



Tags:

return:  returns value of $type


[ Top ]

method getValue [line 752]

mixed getValue( )

gets the value



Tags:

return:  get the value of this element (element-dependent)


[ Top ]

method setValue [line 742]

void setValue( mixed $value)

sets the given value



Parameters:

mixed   $value   set the value of this element

[ Top ]


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