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

Class: parserTocInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserTocInlineTag

Class Overview

Represents {@toc} for table of contents generation in tutorials

Located in /phpDocumentor/InlineTags.inc [line 779]

parserBase
   |
   --parserInlineTag
      |
      --parserTocInlineTag
Author(s): Information Tags:
Version:  $Revision: 1.6 $
Tutorial:  inline {@toc}

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Property Summary
string   $inlinetype   always 'toc'

[ Top ]
Method Summary
parserTocInlineTag   parserTocInlineTag()  
void   Convert()  
void   setPath()  
void   setTOC()  

[ Top ]
Properties
string   $inlinetype = 'toc' [line 785]

always 'toc'


Redefinition of:
parserInlineTag::$inlinetype
the name of the inline tag (like link)

[ Top ]
Methods
Constructor parserTocInlineTag  [line 804]

  parserTocInlineTag parserTocInlineTag( )



[ Top ]
Convert  [line 845]

  void Convert( Converter &$c  )

Parameters:
Converter   &$c: 

API Tags:
Uses:  Converter::getTutorialId() - retrieve the tutorial ID for
Uses:  Converter::formatTutorialTOC() - passes an array of format: <pre> array( 'tagname' => string name of tag, 'link' => tutorialLink to the tutorial, 'id' => converter specific tutorial ID from Converter::getTutorialId() 'title' => title of the tutorial) </pre> and returns the results as the table of contents


[ Top ]
setPath  [line 825]

  void setPath( string $path  )

Parameters:
string   $path: 


[ Top ]
setTOC  [line 817]

  void setTOC( array $toc  )

Parameters:
array   $toc:  format:
 array(array('tag' => parserXMLDocBookTag,
             'id' => parserIdInlineTag,
             'title' => title),...)


[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:23:41 -0500 by phpDocumentor 1.3.1