[ ] [ ] [ ]

Packages:
Converters
Cpdf
HTML_TreeMenu
phpDocumentor
Smarty
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 Tutorial
  - Documentable PHP Elements
  - phpDocumentor Tutorials
- phpDocumentor Manual
  - phpDocumentor tags
    - @abstract
    - @access
    - @author
    - @category
    - @copyright
    - @deprecated
    - @example
    - @final
    - @filesource
    - @global
    - @ignore
    - @internal
    - @license
    - @link
    - @method
    - @name
    - @package
    - @param
    - @property
    - @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}

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
   parserMethodTag
   parserNameTag
   parserParamTag
   parserPropertyReadTag
   parserPropertyTag
   parserPropertyWriteTag
   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

Files:

subpackage DescHTML

DescHTML.inc

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

Errors.inc

subpackage InlineTags

InlineTags.inc

subpackage Links

LinkClasses.inc

subpackage ParserData

ParserData.inc

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Beautifier.php
HighlightParser.inc
Parser.inc
ParserDescCleanup.inc
phpDocumentorTParser.inc
phpDocumentorTWordParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage WordParsers

WordParser.inc

File: TutorialHighlightParser.inc

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/TutorialHighlightParser.inc

Classes:

phpDocumentor_TutorialHighlightParser

Highlights source code using parse()

Page Details:

Source Code Highlighting

The classes in this file are responsible for the dynamic @example, and <programlisting role="tutorial"> tags output. Using the WordParser, the phpDocumentor_TutorialHighlightParser retrieves PHP tokens one by one from the array generated by WordParser source retrieval functions and then highlights them individually.

It accomplishes this highlighting through the assistance of methods in the output Converter passed to its parse() method, and then returns the fully highlighted source as a string

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

LICENSE:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Tutorial: @example, @filesource
Author: Gregory Beaver <cellog@php.net>
Version: CVS: $Id$
Copyright: 2003-2007 Gregory Beaver
Link: http://pear.php.net/PhpDocumentor
Link: http://www.phpdoc.org
Todo: CS cleanup - change package to PhpDocumentor
Todo: CS cleanup - PHPCS needs to ignore CVS Id length
Since: 1.3.0
License: LGPL

STATE_TUTORIAL_ATTRIBUTE [line 568]

STATE_TUTORIAL_ATTRIBUTE = 104

currently parsing an open <tag>

[ Top ]

STATE_TUTORIAL_CLOSETAG [line 578]

STATE_TUTORIAL_CLOSETAG = 105

currently parsing a close </tag>

[ Top ]

STATE_TUTORIAL_COMMENT [line 598]

STATE_TUTORIAL_COMMENT = 107

currently parsing a

[ Top ]

STATE_TUTORIAL_DOUBLEQUOTE [line 618]

STATE_TUTORIAL_DOUBLEQUOTE = 109

currently parsing a

[ Top ]

STATE_TUTORIAL_ENTITY [line 588]

STATE_TUTORIAL_ENTITY = 106

currently parsing an &entity;

[ Top ]

STATE_TUTORIAL_ITAG [line 548]

STATE_TUTORIAL_ITAG = 102

currently parsing an {@inline tag}

[ Top ]

STATE_TUTORIAL_NOEVENTS [line 538]

STATE_TUTORIAL_NOEVENTS = 101

currently in starting state

[ Top ]

STATE_TUTORIAL_OPENTAG [line 558]

STATE_TUTORIAL_OPENTAG = 103

currently parsing an open <tag>

[ Top ]

STATE_TUTORIAL_SINGLEQUOTE [line 608]

STATE_TUTORIAL_SINGLEQUOTE = 108

currently parsing a

[ Top ]

TUTORIAL_EVENT_ATTRIBUTE [line 563]

TUTORIAL_EVENT_ATTRIBUTE = 4

used when a <tag attr="attribute"> is found

[ Top ]

TUTORIAL_EVENT_CLOSETAG [line 573]

TUTORIAL_EVENT_CLOSETAG = 5

used when a close </tag> is found

[ Top ]

TUTORIAL_EVENT_COMMENT [line 593]

TUTORIAL_EVENT_COMMENT = 7

used when a  is found

[ Top ]

TUTORIAL_EVENT_DOUBLEQUOTE [line 613]

TUTORIAL_EVENT_DOUBLEQUOTE = 9

used when a  is found

[ Top ]

TUTORIAL_EVENT_ENTITY [line 583]

TUTORIAL_EVENT_ENTITY = 6

used when an &entity; is found

[ Top ]

TUTORIAL_EVENT_ITAG [line 543]

TUTORIAL_EVENT_ITAG = 2

used when an {@inline tag} is found

[ Top ]

TUTORIAL_EVENT_NOEVENTS [line 533]

TUTORIAL_EVENT_NOEVENTS = 1

starting state

[ Top ]

TUTORIAL_EVENT_OPENTAG [line 553]

TUTORIAL_EVENT_OPENTAG = 3

used when an open <tag> is found

[ Top ]

TUTORIAL_EVENT_SINGLEQUOTE [line 603]

TUTORIAL_EVENT_SINGLEQUOTE = 8

used when a  is found

[ Top ]