Description
parserBase | --parserInlineTag
Located in File: /phpDocumentor/InlineTags.inc
Use this element to represent an {@inline tag} like {@link}
- tutorial: - phpDocumentor Inline tags
- author: - Gregory Beaver <[email protected]>
- version: - Release: @VER@
- copyright: - 2002-2008 Gregory Beaver
- see: - parserStringWithInlineTags
- link: - http://pear.php.net/PhpDocumentor
- link: - http://www.phpdoc.org
- todo: - CS cleanup - change package to PhpDocumentor
- todo: - CS cleanup - change classname to PhpDocumentor_*
- since: - 1.0rc1
- license: - LGPL
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
$type = 'inlinetag' (line 74)
Data type : string
Overrides: Array
Element type
Type is used by many functions to skip the hassle of
Class Constants
Summary:Method Detail
Summary:
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
- 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.
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