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:

actions.php
bug-560532.php
bug-772441.php
builder.php
Classes.inc
clone.inc.php
clone5.inc.php
common.inc.php
config.php
EventStack.inc
file_dialog.php
HighlightParserTests.php
IntermediateParser.inc
IntermediateParserTests.php
Io.inc
new_phpdoc.php
ParserClassTests.php
ParserDescCleanup.inc
ParserPageTests.php
phpdoc.inc
phpdoc.php
phpDocumentorSetupTests.php
phpDocumentorTParserTests.php
ProceduralPages.inc
Publisher.inc
Setup.inc.php
top.php
utilities.php

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

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

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
 |
 --parserElement

all elements except parserPackagePage descend from this abstract class

Author(s):

Greg Beaver <[email protected]>

Version:

$Id: ParserElements.inc 289555 2009年10月12日 03:52:03Z ashnazg $

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Child classes:

parserInclude

parserGlobal

parserFunction

parserClass

parserVar

parserConst

parserDefine

Inherited Variables

Class: parserBase

parserBase::$type
parserBase::$value

Inherited Methods

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 49]
all elements except parserPackagePage descend from this abstract class

Tags:

author: Greg Beaver <[email protected]>

version: $Id: ParserElements.inc 289555 2009年10月12日 03:52:03Z ashnazg $

copyright: 2002-2008 Gregory Beaver

abstract:

since: 1.0rc1

[ Top ]

Class Variables

$conflicts = false

[line 63]

Tags:

var: either false or an array of paths to files with conflicts

Type: mixed

[ Top ]

$docblock = false

[line 54]

Tags:

var: either false or a parserDocBlock

Type: mixed

[ Top ]

$endlinenumber = 0

[line 82]

line number on file where this element stops

Tags:

since: 1.2

Type: false|integer

[ Top ]

$file = ''

[line 69]

location of this element (filename)

Type: string

[ Top ]

$linenumber = false

[line 89]

Line number in the source on which this element appears

Tags:

since: 1.2

Type: false|integer

[ Top ]

$name =

[line 58]

name of this element, or include type if element is a parserInclude

Type: mixed

[ Top ]

$path = ''

[line 75]

full path location of this element (filename)

Type: string

[ Top ]

Class Methods

method getEndLineNumber [line 136]

integer getEndLineNumber(
)

[ Top ]

method getFile [line 178]

string getFile(
)

[ Top ]

method getLineNumber [line 128]

integer getLineNumber(
)

[ Top ]

method getName [line 169]

string getName(
)

[ Top ]

method getPackage [line 142]

string getPackage(
)

Tags:

return: package containing this element

[ Top ]

method getPath [line 187]

string getPath(
)

[ Top ]

method setDocBlock [line 94]

void setDocBlock(
parserDocBlock
$docblock)

Parameters:

parserDocBlock $docblock

[ Top ]

method setEndLineNumber [line 120]

void setEndLineNumber(
integer
$l)

Sets the ending line number of elements

Parameters:

integer $l

[ Top ]

method setFile [line 151]

void setFile(
string
$file)

Parameters:

string $file

[ Top ]

method setLineNumber [line 111]

void setLineNumber(
integer
$number)

Set starting line number

Parameters:

integer $number

[ Top ]

method setName [line 102]

void setName(
string
$name)

Parameters:

string $name

[ Top ]

method setPath [line 157]

void setPath(
string
$file)

Parameters:

string $file

[ Top ]

Documentation generated on 2011年12月06日 07:14:32 -0600 by phpDocumentor 1.4.4