phpDocumentor

[ ] [ ] [ ]

Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Tutorials/Manuals:
В пакете:

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:

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
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

subpackage setup

find_phpdoc.php

subpackage Tutorial

PackagePageElements.inc

subpackage 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
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: phpDocumentorTWordParser

Source Location: /phpDocumentor/phpDocumentorTWordParser.inc

Class Overview

WordParser
   |
   --phpDocumentorTWordParser

Like WordParser, but expects an array of tokens from the tokenizer instead of a string.

Author(s):

Gregory Beaver <cellog@php.net>

Version:

Release: @VER@

Copyright:

2002-2007 Gregory Beaver

Methods

Child classes:

phpDocumentor_HighlightWordParser: Retrieve tokens from an array of tokens organized by line numbers

Inherited Methods

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

Class Details

[line 59]
Like WordParser, but expects an array of tokens from the tokenizer instead of a string.

Tags:

author:	Gregory Beaver <cellog@php.net>
version:	Release: @VER@
copyright:	2002-2007 Gregory Beaver
link:	http://pear.php.net/PhpDocumentor
link:	http://www.phpdoc.org
todo:	CS cleanup - change package to PhpDocumentor
todo:	CS cleanup - change classname to PhpDocumentor_*
since:	1.2
license:	LGPL

[ Top ]

Class Methods

static method concatTokens [line 193]

static string concatTokens(
array
$a)

Utility function to convert a series of tokens into a string

Tags:

return:

the resulting string

Parameters:

array

array of tokens

[ Top ]

static method tokenEquals [line 178]

static bool tokenEquals(
mixed
$a, mixed
$b)

Utility function to determine whether two tokens from the tokenizer are equal

Tags:

return:

whether or not the tokens are equal

Parameters:

mixed	$a	first token
mixed	$b	second token

[ Top ]

method addFileSource [line 278]

void addFileSource(
array
$word)

Wrapper for addSource() used to retrieve the entire source code organized by line number in setup()

Parameters:

array

$word

full file source code

[ Top ]

method addSource [line 300]

void addSource(
array|string
$word, [bool
$file = false])

Generate source token arrays organized by line number

This code will split up tokens that contain "\n" and add them to the source code as separate tokens on different lines.

Tags:

uses:

_set_sars()

Parameters:

array\|string	$word	token to add
bool	$file	true if this should be added to $_file_source

[ Top ]

method backupPos [line 361]

int|void backupPos(
)

backs the parser up to the previous position

method findGlobal [line 347]

void findGlobal(
array
$tokens)

Tell the phpDocumentorTWordParser to return the entire global variable if it is found.

Tags:

uses:

$_global_search

Parameters:

array

$tokens

tokens that represent the global variable definition

[ Top ]

method getFileSource [line 148]

array getFileSource(
)

gets the source code tokens

Tags:

return:	source code tokens split up by line number
usedby:	parserExampleTag::parserExampleTag() - uses to parse an example and retrieve all tokens by line number

[ Top ]

method getSource [line 135]

array getSource(
)

loads up next set of source code

Tags:

return:

source code array

Overrides WordParser::getSource() (Retrieve source code for the last function/method)

[ Top ]

method getWord [line 218]

string|array getWord(
)

Retrieve a token for the phpDocumentorTParser

method setup [line 117]

void setup(
string
&$input)

Uses http://www.php.net/token_get_all to tokenize the source code.

Overridden in child classes as:

phpDocumentor_HighlightWordParser::setup(): Initialize the parser object

Overrides WordParser::setup() (Initialize the WordParser)

Parameters:

string

&$input

source code

[ Top ]

PHP5

Для web разработчика

Dec 21
Docs For Class phpDocumentorTWordParser

Class: phpDocumentorTWordParser

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Methods

Class: WordParser

Class Details

Tags:

Class Methods

static method concatTokens [line 193]

Tags:

Parameters:

static method tokenEquals [line 178]

Tags:

Parameters:

method addFileSource [line 278]

Parameters:

method addSource [line 300]

Tags:

Parameters:

method backupPos [line 361]

Tags:

method findGlobal [line 347]

Tags:

Parameters:

method getFileSource [line 148]

Tags:

method getSource [line 135]

Tags:

method getWord [line 218]

Tags:

method setup [line 117]

Parameters:

PHP5

Для web разработчика

Dec 21Docs For Class phpDocumentorTWordParser

Class: phpDocumentorTWordParser

Class Overview

Author(s):

Version:

Copyright:

Methods

Child classes:

Inherited Methods

Class: WordParser

Class Details

Tags:

Class Methods

static method concatTokens [line 193]

Tags:

Parameters:

static method tokenEquals [line 178]

Tags:

Parameters:

method addFileSource [line 278]

Parameters:

method addSource [line 300]

Tags:

Parameters:

method backupPos [line 361]

Tags:

method findGlobal [line 347]

Tags:

Parameters:

method getFileSource [line 148]

Tags:

method getSource [line 135]

Tags:

method getWord [line 218]

Tags:

method setup [line 117]

Parameters:

Dec 21
Docs For Class phpDocumentorTWordParser