Class parserInheritdocInlineTag

Description
Description | Vars (details) | Methods (details)

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
Variable Summary
Description | Vars (details) | Methods (details)
string $inlinetype
Method Summary
Description | Vars (details) | Methods (details)
parserInheritdocInlineTag parserInheritdocInlineTag ()
string Convert ()
Variables
Description | Vars (details) | Methods (details)
string $inlinetype = 'inheritdoc' (line 795)

always 'inheritdoc'

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

Inherited Variables

Inherited from parserInlineTag

parserInlineTag::$type

Inherited from parserBase

parserBase::$value
Methods
Description | Vars (details) Methods (details)
Constructor parserInheritdocInlineTag (line 800)

Does nothing, overrides parent constructor

parserInheritdocInlineTag parserInheritdocInlineTag ()
Convert (line 810)

only sets a warning and returns empty

  • todo: CS cleanup - rename to convert for camelCase rule
string Convert ()

Inherited Methods

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
parserInlineTag::getString()
parserInlineTag::Strlen()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Documentation generated on Mon, 05 Dec 2011 21:05:43 -0600 by phpDocumentor 1.4.4