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

Class: parserInheritdocInlineTag

Source Location: /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: @VER@

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



Tags:

tutorial:  inline {@inheritdoc}
author:  Gregory Beaver <cellog@php.net>
version:  Release: @VER@
copyright:  2002-2008 Gregory Beaver
see:  parserStringWithInlineTags
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


[ Top ]


Class Variables

$inlinetype =  'inheritdoc'

[line 795]

always 'inheritdoc'


Type:   string
Overrides:   Array


[ Top ]



Class Methods


constructor parserInheritdocInlineTag [line 800]

parserInheritdocInlineTag parserInheritdocInlineTag( )

Does nothing, overrides parent constructor



[ Top ]

method Convert [line 810]

string Convert( )

only sets a warning and returns empty



Tags:

todo:  CS cleanup - rename to convert for camelCase rule


[ Top ]


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