Class: parserInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag

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

Author(s):

Gregory Beaver <[email protected]>

Version:

Release: @VER@

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

Class: parserBase

parserBase::$value

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}

Tags:

tutorial:	phpDocumentor Inline tags
author:	Gregory Beaver <[email protected]>
version:	Release: @VER@
copyright:	2002-2008 Gregory Beaver
see:	parserStringWithInlineTags
link:	http://pear.php.net/PhpDocumentor
link:	http://www.phpdoc.org
todo:	CS cleanup - change package to PhpDocumentor
todo:	CS cleanup - change classname to PhpDocumentor_*
since:	1.0rc1
license:	LGPL

[ 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

if phpDocumentor_get_class($blah) == 'parserBlah'

always "inlinetag"

Type:	string
Overrides:	Array

[ Top ]

Class Methods

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

method getString [line 117]

string getString(
)

always gets an empty string

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.

Overridden in child classes as:

parserSourceInlineTag::getString(): gets the source string

[ Top ]

method Strlen [line 99]

integer Strlen(
)

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

[ Top ]

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