Class: parserTutorialTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview [line 995]

represents "@tutorial"

Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods

Class: parserSeeTag

parserSeeTag::parserSeeTag()
sets up the see tag
parserSeeTag::Convert()
process this tag through the given output converter

Class: parserLinkTag

parserLinkTag::parserLinkTag()
sets up the link tag

Class: parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString()
Returns the text minus any inline tags
parserTag::HandleEvent()
Called by the parserDescParser when processing a description.

Class: parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Class: parserBase

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


Class Details

represents "@tutorial"

This is exactly like @see except that it only links to tutorials

Tags:

[ Top ]


Class Variables

$keyword =  'tutorial'

[line 1001]

Always "tutorial"

Type: string

Overrides: Array

[ Top ]


Class Methods

Convert

string|bool Convert( Converter &$converter)

[line 1012]

process this tag through the given output converter

Tags:

Overrides parserSeeTag::Convert() (process this tag through the given output converter)

Parameters:

  • Converter &$converter - the output converter

[ Top ]


Class Constants


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