Docs For Class parserInlineTag

Description

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

parserBase
   |
   --parserInlineTag

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 ()

Variables

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

always "inlinetag"

Redefinition of:

Inherited from parserBase

parserBase::$value

Methods

Constructor parserInlineTag (line 87)

sets up the tag

parserInlineTag parserInlineTag (string $type, string $value)

getString (line 117)

always gets an empty string

return: always '', used by Parser::handleDocBlock() to calculate the short description of a DocBlock
see: parserStringWithInlineTags::getString()
see: parserStringWithInlineTags::trimmedStrlen()
usedby: parserStringWithInlineTags::getString() - removes inline tag length, as it is indeterminate until conversion.

string getString ()

Redefined in descendants as:

Strlen (line 99)

get length of the tag

integer Strlen ()

Redefined in descendants as:

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

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()