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 61]

Author(s): API Tags:
See:  parserStringWithInlineTags

Information Tags:
Tutorial:  phpDocumentor Inline tags
Version:  Release: @[email protected]
Copyright:  2002-2008 Gregory Beaver
Todo:  CS cleanup - change package to PhpDocumentor
Todo:  CS cleanup - change classname to PhpDocumentor_*
Since:  1.0rc1
License:  LGPL



[ Top ]
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 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

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

Inherited From parserBase


Inherited From parserBase

gets the type
gets the value
sets the given value

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

[ Top ]
Method Summary
parserInlineTag   parserInlineTag()   sets up the tag
string   getString()   always gets an empty string
integer   Strlen()   get length of the tag

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

the name of the inline tag (like link)

Redefined in descendants as:

[ Top ]
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

[ Top ]
Constructor parserInlineTag  [line 87]

  parserInlineTag parserInlineTag( string $type, string $value  )

sets up the tag

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

[ Top ]
getString  [line 117]

  string getString( )

always gets an empty string

API Tags:
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.

Redefined in descendants as:

[ Top ]
Strlen  [line 99]

  integer Strlen( )

get length of the tag

API Tags:
Return:  length of the tag

Information Tags:
Todo:  CS cleanup - rename to strLen for camelCase rule

Redefined in descendants as:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:02 -0600 by phpDocumentor 1.4.4