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

Class: parserInlineTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag

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


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Variables

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 Methods

Class: parserBase

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

Class Details

[line 61]
Use this element to represent an {@inline tag} like {@link}


[ Top ]


Class Variables

$inlinetype =  ''

[line 79]

the name of the inline tag (like link)

Type:   string


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



Method Detail

parserInlineTag (Constructor)   [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)

[ Top ]

getString   [line 117]

string getString( )

always gets an empty string

Overridden in child classes as:

parserSourceInlineTag::getString()
gets the source string

[ Top ]

Strlen   [line 99]

integer Strlen( )

get length of the tag
  • 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

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:00 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.