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

Class: parserInlineTag

Source Location: /phpDocumentor/

Class parserInlineTag

Class Overview

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

Located in /phpDocumentor/ [line 49]

Author(s): API Tags:
See:  parserStringWithInlineTags

Information Tags:
Tutorial:  phpDocumentor Inline tags
Version:  $Revision: 1.6 $
Since:  1.0rc1



[ Top ]
Direct descendents
Child 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
parserIdInlineTag Represents the inline {@id} tag for tutorials
parserTocInlineTag Represents {@toc} for table of contents generation in tutorials

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserBase


Inherited From parserBase


[ Top ]
Property Summary
string   $inlinetype   the name of the inline tag (like link)
string   $type   Element type

[ Top ]
Method Summary
parserInlineTag   parserInlineTag()  
string   getString()  
integer   Strlen()  

[ Top ]
string   $inlinetype = '' [line 67]

the name of the inline tag (like link)

Redefined in descendants as:

[ Top ]
string   $type = 'inlinetag' [line 62]

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 phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]
Constructor parserInlineTag  [line 73]

  parserInlineTag parserInlineTag( string $type, string $value  )

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

[ Top ]
getString  [line 99]

  string getString( )

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

Redefined in descendants as:

[ Top ]
Strlen  [line 82]

  integer Strlen( )

API Tags:
Return:  length of the tag

Redefined in descendants as:

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:23:40 -0500 by phpDocumentor 1.3.1