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

Class: parserInheritdocInlineTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/InlineTags.inc

Class Overview

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:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

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

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


[ Top ]


Class Variables

$inlinetype =  'inheritdoc'

[line 795]

always 'inheritdoc'

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserInheritdocInlineTag (Constructor)   [line 800]

parserInheritdocInlineTag parserInheritdocInlineTag( )

Does nothing, overrides parent constructor

[ Top ]

Convert   [line 810]

string Convert( )

only sets a warning and returns empty
  • Todo: CS cleanup - rename to convert for camelCase rule

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:00 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.