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

Class: parserInheritdocInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserInheritdocInlineTag

Class Overview

Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible

Located in /phpDocumentor/InlineTags.inc [line 789]

parserBase
   |
   --parserInlineTag
      |
      --parserInheritdocInlineTag
Author(s): API Tags:
See:  parserStringWithInlineTags

Information Tags:
Tutorial:  inline [email protected]}
Version:  Release: @VER@
Copyright:  2002-2008 Gregory Beaver
Link:  http://www.phpdoc.org
Link:  http://pear.php.net/PhpDocumentor
Todo:  CS cleanup - change classname to PhpDocumentor_*
Todo:  CS cleanup - change package to PhpDocumentor
License:  LGPL

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserInlineTag

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag::getString()
always gets an empty string
parserInlineTag::Strlen()
get length of the tag

Inherited From parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

[ Top ]
Property Summary
string   $inlinetype   always 'inheritdoc'

[ Top ]
Method Summary
parserInheritdocInlineTag   parserInheritdocInlineTag()   Does nothing, overrides parent constructor
string   Convert()   only sets a warning and returns empty

[ Top ]
Properties
string   $inlinetype = 'inheritdoc' [line 795]

always 'inheritdoc'


Redefinition of:
parserInlineTag::$inlinetype
the name of the inline tag (like link)

[ Top ]
Methods
Constructor parserInheritdocInlineTag  [line 800]

  parserInheritdocInlineTag parserInheritdocInlineTag( )

Does nothing, overrides parent constructor



[ Top ]
Convert  [line 810]

  string Convert( )

only sets a warning and returns empty


Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:02 -0600 by phpDocumentor 1.4.4