Inherited Methods
Class: parserInlineTag
- parserInlineTag::parserInlineTag()
- sets up the tag
- parserInlineTag::getString()
- always gets an empty string
- parserInlineTag::Strlen()
- get length of the tag
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
Represents {@toc} for table of contents generation in tutorials
Tags:
- tutorial - inline {@toc}
- author - Gregory Beaver <[email protected]>
- version - Release: @VER@
- copyright - 2002-2008 Gregory Beaver
- see - parserStringWithInlineTags
- link - http://www.phpdoc.org
- link - http://pear.php.net/PhpDocumentor
- todo - CS cleanup - change classname to PhpDocumentor_*
- todo - CS cleanup - change package to PhpDocumentor
- license - LGPL
[ Top ]
Class Variables
$inlinetype = 'toc'
[ Top ]
Class Methods
parserTocInlineTag
[ Top ]
Convert
mixed Convert(
Converter
&$c)
[line 1015]
converter method
array(
'tagname' => string name of tag,
'link' => tutorialLink to the tutorial,
'id' => converter specific tutorial ID from
Converter::getTutorialId()
'title' => title of the tutorial) and returns the results as the table of contentsTags:
- todo - CS cleanup - rename to convert for camelCase rule
- uses - Converter::getTutorialId() - retrieve the tutorial ID for
- uses - Converter::formatTutorialTOC() - passes an array of format:
Parameters:
- Converter &$c - converter object
[ Top ]
setPath
[ Top ]
setTOC
void setTOC(
array
$toc)
[line 978]
set the TOC
Parameters:
-
array
$toc
-
format:
array( array( 'tag' => parserXMLDocBookTag, 'id' => parserIdInlineTag, 'title' => title ), ... )
[ Top ]