Class parserInlineTag


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

Located in /phpDocumentor/ (line 61)

Direct descendents
Class Description
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
Variable Summary
string $inlinetype
string $type
Method Summary
parserInlineTag parserInlineTag (string $type, string $value)
string getString ()
integer Strlen ()
string $inlinetype = '' (line 79)

the name of the inline tag (like link)

Redefined in descendants as:
string $type = 'inlinetag' (line 74)

Element type

Type is used by many functions to skip the hassle of

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

Redefinition of:
Type is used by many functions to skip the hassle of if

Inherited Variables

Inherited from parserBase

Constructor parserInlineTag (line 87)

sets up the tag

parserInlineTag parserInlineTag (string $type, string $value)
  • string $type: tag type (example: link)
  • string $value: tag value (example: what to link to)
getString (line 117)

always gets an empty string

string getString ()

Redefined in descendants as:
Strlen (line 99)

get length of the tag

  • return: length of the tag
  • todo: CS cleanup - rename to strLen for camelCase rule
integer Strlen ()

Redefined in descendants as:

Inherited Methods

Inherited From parserBase


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