Class: parserInheritdocInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview [line 789]

parserBase
   |
   --parserInlineTag
      |
      --parserInheritdocInlineTag

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

Author(s):

Version:

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods

Class: parserInlineTag

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

Class: parserBase

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


Class Details

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

Tags:

[ Top ]


Class Variables

$inlinetype =  'inheritdoc'

[line 795]

always 'inheritdoc'

Type: string

Overrides: Array

[ Top ]


Class Methods

parserInheritdocInlineTag

parserInheritdocInlineTag parserInheritdocInlineTag( )

[line 800]

Does nothing, overrides parent constructor

Parameters:

[ Top ]

Convert

string Convert( )

[line 810]

only sets a warning and returns empty

Tags:

  • todo - CS cleanup - rename to convert for camelCase rule

Parameters:

[ Top ]


Class Constants


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