Description
parserBase | --parserInlineTag | --parserTocInlineTag
Located in File: /phpDocumentor/InlineTags.inc
Represents {@toc} for table of contents generation in tutorials
- 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
$inlinetype = 'toc' (line Class Constants
Summary:Method Detail
Summary:
parserTocInlineTag
parserTocInlineTag
()
Constructor parserTocInlineTag (line
Method Convert (line 1015)
mixed Convert( Converter &$c)
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 contentsParameters
- Converter &$c: converter object
Info
- 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:
Method setPath (line 990)
void setPath( string $path)
set the path
Parameters
- string $path: the path
Info
Method setTOC (line 978)
void setTOC( array $toc)
set the TOC
Parameters
- array $toc: format:
array( array( 'tag' => parserXMLDocBookTag, 'id' => parserIdInlineTag, 'title' => title ), ... )