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

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

Class Overview

Author(s):

Joshua Eichorn <mailto:jeichorn at phpdoc.org>

Version:

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

Variables

Methods

Child classes:

ObjectWordParser: Like WordParser but designed to handle an array with strings and

phpDocumentorTWordParser

Inherited Variables

Inherited Methods

Class Details

[line 13]

Version: $Id: WordParser.inc,v 1.24 2003/01/01 07:23:12 CelloG Exp $
Author: Joshua Eichorn <mailto:jeichorn@phpdoc.org>

[ Top ]

Class Variables

$cache =

[line 30]

Type:

mixed

[ Top ]

$data =

[line 28]

Type:

mixed

[ Top ]

$getsource = false

[line 38]

Type:

mixed

[ Top ]

$linenum = 0

[line 32]

Type:

mixed

[ Top ]

$linenumpos = 0

[line 34]

Type:

mixed

[ Top ]

$pos = 0

[line 24]

Type:

mixed

[ Top ]

$returnWhiteSpace = false

[line 43]

return whitespace

Type:

mixed

[ Top ]

$size =

[line 26]

Type:

mixed

[ Top ]

$source = ''

[line 36]

Type:

mixed

[ Top ]

$wordseperators = array()

[line 22]

Type:

mixed

[ Top ]

Method Detail

backupPos [line 176]

void backupPos(
mixed
$word)

Overridden in child classes as:

phpDocumentorTWordParser::backupPos()

[ Top ]

getBlock [line 161]

void getBlock(
mixed
$start, mixed
$len)

[ Top ]

getPos [line 156]

void getPos(
)

Returns the current pointer position, or 1 character after the end of the word

[ Top ]

getSource [line 57]

void getSource(
)

Overridden in child classes as:

phpDocumentorTWordParser::getSource()

[ Top ]

getWord [line 71]

void getWord(
)

Overridden in child classes as:

ObjectWordParser::getWord()

phpDocumentorTWordParser::getWord()

[ Top ]

retrievesource [line 65]

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

Overridden in child classes as:

phpDocumentorTWordParser::retrievesource()

[ Top ]

setPos [line 171]

void setPos(
mixed
$pos)

[ Top ]

setSeperator [line 166]

void setSeperator(
mixed
&$seps)

[ Top ]

setup [line 45]

void setup(
mixed
&$input)

Overridden in child classes as:

ObjectWordParser::setup()

phpDocumentorTWordParser::setup()

[ Top ]

setWhitespace [line 185]

void setWhitespace(
[mixed
$val = false])

set parser to return or strip whitespace

[ Top ]

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