	phpDocumentor WordParsers

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

phpDocumentor

Packages:

phpDocumentor
Converters

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}

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

bug_772441
Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
tests_HighlightParserTests
tests_IntermediateParserTests
tests_ParserClassTests
tests_ParserPageTests
tests_phpDocumentorSetupTests
tests_phpDocumentorTParserTests

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

Class: ObjectWordParser

Source Location: /phpDocumentor/ParserDescCleanup.inc

Class ObjectWordParser

Class Overview

Like WordParser but designed to handle an array with strings and

parserInlineTags

Located in /phpDocumentor/ParserDescCleanup.inc [line 130]

WordParser
   |
   --ObjectWordParser

Author(s):

Greg Beaver <[email protected]>

API Tags:

Usedby:

XMLPackagePageParser::XMLPackagePageParser()

Information Tags:

Version:	Release: @VER@
Copyright:	2000-2007 Joshua Eichorn
Since:	1.2

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From WordParser

WordParser::backupPos()

Backup to the previous token so that it can be retrieved again in a new context.

WordParser::getBlock()

Unused

WordParser::getPos()

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

WordParser::getSource()

Retrieve source code for the last function/method

WordParser::getWord()

Retrieve a token from the token list

WordParser::setPos()

Set the internal cursor within the source code

WordParser::setSeperator()

Sets the list of possible separator tokens

WordParser::setup()

Initialize the WordParser

WordParser::setWhitespace()

set parser to return or strip whitespace

[ Top ]

Method Summary

ObjectWordParser	ObjectWordParser()
void	getWord()
boolean	nextIsObjectOrNonNL()	Determine if the next word is an inline tag
void	setup()	Set the word parser to go.

[ Top ]

Methods

Constructor ObjectWordParser [line 138]

ObjectWordParser ObjectWordParser(
[
$casesensitive = false] 
)

Parameters:

$casesensitive:

[ Top ]

getWord [line 166]

void getWord(
)

Redefinition of:

WordParser::getWord(): Retrieve a token from the token list

[ Top ]

nextIsObjectOrNonNL [line 281]

boolean nextIsObjectOrNonNL(
)

Determine if the next word is an inline tag

[ Top ]

setup [line 149]

void setup(
array
&$input 
)

Set the word parser to go.

Parameters:

array

&$input:

parserStringWithInlineTags::$value style-array, with alternating text and inline tags

Redefinition of:

WordParser::setup(): Initialize the WordParser

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:40 -0600 by phpDocumentor 1.4.4