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

Class: parserInlineTag

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag

Use this element to represent an {@inline tag} like link (see the phpDocumentor spec for more information about inline tags)


Author(s):

Version:

  • $Id: InlineTags.inc,v 1.4 2003/01/02 06:28:48 CelloG Exp $

Variables

Methods


Child classes:

parserLinkInlineTag
represents inline links
parserSourceInlineTag
represents inline source tag
parserInheritdocInlineTag
represents the inheritdoc inline tag, used by classes/methods/vars to inherit documentation from the parent class if possible
parserIdInlineTag
Use this element to represent an {@inline tag} like link (see the phpDocumentor spec for more information about inline tags)
parserTocInlineTag
Use this element to represent an {@inline tag} like link (see the phpDocumentor spec for more information about inline tags)

Inherited Variables

Inherited Methods


Class Details

[line 17]
Use this element to represent an {@inline tag} like link (see the phpDocumentor spec for more information about inline tags)


[ Top ]


Class Variables

$inlinetype =  ''

[line 29]

the name of the inline tag (like link)

Type:   string


[ Top ]

$type =  'inlinetag'

[line 24]

Type is used by many functions to skip the hassle of if get_class($blah) == 'parserBlah'

always 'inlinetag'


Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserInlineTag (Constructor)   [line 35]

parserInlineTag parserInlineTag( string $type, string $value)


Parameters:

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

[ Top ]

getString   [line 54]

string getString( )


[ Top ]

Strlen   [line 44]

integer Strlen( )

  • Return: length of the tag

Overridden in child classes as:

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

[ Top ]


Documentation generated on Fri, 30 Apr 2004 22:10:05 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.