Class parserInlineTag

(line 61)

Description

parserBase
   |
   --parserInlineTag

Located in File: /phpDocumentor/InlineTags.inc

Use this element to represent an {@inline tag} like {@link}


Classes extended from parserInlineTag:
parserLinkInlineTag
represents inline links
parserSourceInlineTag
represents inline source tag, used for function/method source
parserInheritdocInlineTag
Represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
parserIdInlineTag
Represents the inline {@id} tag for tutorials
parserTocInlineTag
Represents {@toc} for table of contents generation in tutorials

Class Variables

Summary:
string $inlinetype
string $type

$inlinetype = '' (line 79)

Data type : string

the name of the inline tag (like link)

$type = 'inlinetag' (line 74)

Data type : string

Overrides: Array

Element type

Type is used by many functions to skip the hassle of

  1.  if phpDocumentor_get_class($blah== 'parserBlah'
always "inlinetag"

Class Constants

Summary:

Method Detail

Summary:
parserInlineTag parserInlineTag (string $type, string $value)
string getString ()
integer Strlen ()

Constructor parserInlineTag (line 87)

parserInlineTag parserInlineTag( string $type, string $value)

sets up the tag

Parameters

  • string $type: tag type (example: link)
  • string $value: tag value (example: what to link to)

Info

Method getString (line 117)

string getString( )

Overridden in child classes as:

parserSourceInlineTag::getString()
gets the source string

always gets an empty string

Info

Method Strlen (line 99)

integer Strlen( )

Overridden in child classes as:

parserSourceInlineTag::Strlen()
only used to determine blank lines. {@source} will not be blank, probably

get length of the tag

Info

  • return - length of the tag
  • todo - CS cleanup - rename to strLen for camelCase rule

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



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