Class: parserInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview [line 61]

parserBase
   |
   --parserInlineTag

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

Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods


Child classes:

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

Inherited Variables

Inherited Constants

Inherited Methods

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value


Class Details

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

Tags:

[ Top ]


Class Variables

$inlinetype =  ''

[line 79]

the name of the inline tag (like link)

Type: string

Overrides:

[ Top ]

$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"

Type: string

Overrides: Array

[ Top ]


Class Methods

parserInlineTag

parserInlineTag parserInlineTag( string $type, string $value)

[line 87]

sets up the tag

Parameters:

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

[ Top ]

getString

string getString( )

[line 117]

always gets an empty string

Tags:

Overridden in child classes as:

parserSourceInlineTag::getString()
gets the source string

Parameters:

[ Top ]

Strlen

integer Strlen( )

[line 99]

get length of the tag

Tags:

  • return - length of the tag
  • todo - CS cleanup - rename to strLen for camelCase rule

Overridden in child classes as:

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

Parameters:

[ Top ]


Class Constants


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