phpDocumentor

[ ] [ ] [ ]

Packages:
PhpDocumentor
apidoc
Converters
HTML_TreeMenu
Pdf-php
PEAR
phpDocumentor
Smarty
tests

Tutorials/Manuals:
Package-level:

phpDocumentor Guide to Creating Fantastic Documentation
- phpDocumentor 1.2.0 Manual
  - phpDocumentor 1.2.0 Tutorial
    - Documentable PHP Elements
    - phpDocumentor Tutorials
  - phpDocumentor tags
    - @access
    - @author
    - @copyright
    - @deprecated
    - @example
    - @filesource
    - @global
    - @ignore
    - @internal
    - @link
    - @name
    - @package
    - @param
    - @return
    - @see
    - @since
    - @static
    - @staticvar
    - @subpackage
    - @todo
    - @tutorial
    - @uses
    - @var
    - @version
  - phpDocumentor Inline tags
    - inline {@id}
    - inline {@internal}}
    - inline {@inheritdoc}
    - inline {@link}
    - inline {@source}
    - inline {@toc}
    - inline {@tutorial}

Files:

Classes.inc
common.inc.php
create_examples.php
EventStack.inc
IntermediateParser.inc
Io.inc
new_phpdoc.php
phpdoc.inc
phpdoc.php
ProceduralPages.inc
Publisher.inc
Template.inc
WordParser.inc

subpackage DescHTML

subpackage DocBlockTags

DocBlockTags.inc

subpackage Errors

subpackage InlineTags

subpackage Links

LinkClasses.inc

subpackage ParserData

subpackage ParserDocBlock

ParserDocBlock.inc

subpackage ParserElements

ParserElements.inc

subpackage Parsers

Parser.inc
ParserDescCleanup.inc
phpDocumentorTParser.inc
XMLpackagePageParser.inc

subpackage Tutorial

PackagePageElements.inc

Classes:

Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
Template

DescHTML
   parserB
   parserBr
   parserCode
   parserI
   parserList
   parserPre

PhpDocumentor-1.2.0beta2
   classLink
   defineLink
   DirNode
   functionLink
   globalLink
   methodLink
   pageLink
   parserAccessTag
   parserClass
   parserDefine
   parserElement
   parserExampleTag
   parserFileSourceTag
   parserFunction
   parserGlobal
   parserIdInlineTag
   parserInclude
   parserInheritdocInlineTag
   parserLinkInlineTag
   parserLinkTag
   parserMethod
   parserNameTag
   parserPackagePage
   parserParamTag
   parserReturnTag
   parserSeeTag
   parserSourceInlineTag
   parserSourceTag
   parserStaticvarTag
   parserStringWithInlineTags
   parserTocInlineTag
   parserTutorial
   parserTutorialInlineTag
   parserTutorialTag
   parserUsedByTag
   parserUsesTag
   parserVar
   parserVarTag
   phpDocumentorTWordParser
   RecordException
   tutorialLink
   varLink

DocBlockTags
parserTag

Errors
   ErrorTracker
   RecordError
   RecordWarning

InlineTags
parserInlineTag

Links
abstractLink

Tutorial
parserCData
parserXMLDocBookTag

Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   ppageParser
   XMLPackagePageParser

ParserData
   parserBase
   parserData
   parserPage

WordParsers
ObjectWordParser
WordParser

ParserDocBlock
parserDesc
parserDocBlock

Class: phpDocumentorTWordParser

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/phpDocumentorTWordParser.inc

Class Overview

WordParser
   |
   --phpDocumentorTWordParser

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: WordParser.inc,v 1.24 2003/01/01 07:23:12 CelloG Exp $

Methods

Inherited Variables

Class: WordParser

WordParser::$cache
WordParser::$data
WordParser::$getsource
WordParser::$linenum
WordParser::$linenumpos
WordParser::$pos
WordParser::$returnWhiteSpace
WordParser::$size
WordParser::$source
WordParser::$wordseperators

Inherited Methods

Class: WordParser

WordParser::backupPos()
WordParser::getBlock()
WordParser::getPos(): Returns the current pointer position, or 1 character after the end of the word
WordParser::getSource()
WordParser::getWord()
WordParser::retrievesource()
WordParser::setPos()
WordParser::setSeperator()
WordParser::setup()
WordParser::setWhitespace(): set parser to return or strip whitespace

Class Details

[line 6]

Version: $Id: WordParser.inc,v 1.24 2003/01/01 07:23:12 CelloG Exp $
Since: 1.2
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Method Detail

addFileSource [line 127]

void addFileSource(
mixed
$word)

[ Top ]

addSource [line 136]

void addSource(
mixed
$word, [mixed
$file = false])

[ Top ]

backupPos [line 176]

void backupPos(
)

Overrides WordParser::backupPos() (parent method not documented)

[ Top ]

concatTokens [line 75]

void concatTokens(
mixed
$a)

[ Top ]

findGlobal [line 167]

void findGlobal(
mixed
$tokens)

[ Top ]

getFileSource [line 56]

void getFileSource(
)

[ Top ]

getSource [line 48]

void getSource(
)

Overrides WordParser::getSource() (parent method not documented)

[ Top ]

getWord [line 86]

void getWord(
)

Overrides WordParser::getWord() (parent method not documented)

[ Top ]

retrievesource [line 61]

void retrievesource(
[mixed
$word = ''])

Overrides WordParser::retrievesource() (parent method not documented)

[ Top ]

setup [line 37]

void setup(
mixed
&$input)

Overrides WordParser::setup() (parent method not documented)

[ Top ]

tokenEquals [line 68]

void tokenEquals(
mixed
$a, mixed
$b)

[ Top ]

Documentation generated on Fri, 30 Apr 2004 22:10:39 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.