	phpDocumentor InlineTags

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

phpDocumentor

Packages:

phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Tutorials/Manuals:

Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor Quickstart
  - Source code for sample1.php
  - Source code for sample2.php
  - Source code for sample3.php
- phpDocumentor 1.3.1 Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor 1.3.1 Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @name
    - @package
    - @param
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@example}
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

DescHTML
DescHTML.inc

DocBlockTags
DocBlockTags.inc

Errors
Errors.inc

InlineTags
InlineTags.inc

Links
LinkClasses.inc

ParserData
ParserData.inc

ParserDocBlock
ParserDocBlock.inc

ParserElements
ParserElements.inc

Parsers
Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

setup
find_phpdoc.php

Tutorial
PackagePageElements.inc

WordParsers
phpDocumentorTWordParser.inc
WordParser.inc

Classes:

Parsers
Parser
parserDescParser
phpDocumentorTParser
phpDocumentor_HighlightParser
phpDocumentor_HighlightWordParser
phpDocumentor_peardoc2_XML_Beautifier
phpDocumentor_TutorialHighlightParser
phpDocumentor_XML_Beautifier_Tokenizer
ppageParser
XMLPackagePageParser

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher

DescHTML
parserB
parserBr
parserCode
parserDescVar
parserI
parserKbd
parserList
parserPre
parserSamp

DocBlockTags
parserAccessTag
parserExampleTag
parserFileSourceTag
parserLicenseTag
parserLinkTag
parserNameTag
parserParamTag
parserReturnTag
parserSeeTag
parserStaticvarTag
parserTag
parserTutorialTag
parserUsedByTag
parserUsesTag
parserVarTag

Errors
ErrorTracker
RecordError
RecordWarning

InlineTags
parserExampleInlineTag
parserIdInlineTag
parserInheritdocInlineTag
parserInlineTag
parserLinkInlineTag
parserSourceInlineTag
parserTocInlineTag
parserTutorialInlineTag

Links
abstractLink
classLink
constLink
defineLink
functionLink
globalLink
methodLink
pageLink
tutorialLink
varLink

Tutorial
parserCData
parserEntity
parserXMLDocBookTag

ParserData
parserBase
parserData
parserPage
parserStringWithInlineTags

WordParsers
ObjectWordParser
phpDocumentorTWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

ParserElements
parserClass
parserConst
parserDefine
parserElement
parserFunction
parserGlobal
parserInclude
parserMethod
parserPackagePage
parserTutorial
parserVar

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):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Revision: 1.6 $
Tutorial:	inline {@toc}

$inlinetype

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserInlineTag

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()

parserInlineTag::getString()

parserInlineTag::Strlen()

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

string

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