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

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
 |
 --parserElement
 |
 --parserVar

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

Inherited Variables

Class: parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$endlinenumber
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Class: parserBase

parserBase::$value

Inherited Methods

Class: parserElement

parserElement::getEndLineNumber()
parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setEndLineNumber(): Sets the ending line number of elements
parserElement::setFile()
parserElement::setLineNumber(): Set starting line number
parserElement::setName()
parserElement::setPath()

Class: parserBase

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

Class Details

[line 1415]

Tags:

author: Greg Beaver <[email protected]>

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

copyright: 2002-2008 Gregory Beaver

since: 1.0rc1

[ Top ]

Class Variables

$class = ''

[line 1423]

Tags:

var: class that contains this var

Type: string

[ Top ]

$type = 'var'

[line 1421]

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

Tags:

var: always 'var'

Type: string

Overrides: Array

[ Top ]

$_modifiers =

[line 1425]

Type: array

[ Top ]

Class Methods

constructor parserVar [line 1430]

parserVar parserVar(
string
$class)

Parameters:

string $class

[ Top ]

method getClass [line 1439]

string getClass(
)

Retrieve the class name

Tags:

return: Class name that this var belongs to

[ Top ]

method getLink [line 1468]

mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])

quick way to link to this element

Tags:

return: converter-specific link to this var

Parameters:

Converter $c

string $text text to display for the link or false for default text

$returnobj

[ Top ]

method getModifiers [line 1448]

array getModifiers(
)

Return a list of access modifiers (static/private/etc.)

[ Top ]

method getOverrides [line 1481]

mixed getOverrides(
Converter
&$c)

Tags:

return: parserVar representing var this var overrides from the parent class, or false if none

Parameters:

Converter &$c

[ Top ]

method getOverridingVars [line 1540]

array getOverridingVars(
Converter
&$c)

Tags:

return: an array of parserVars from ALL child classes that override this var

usedby: Converter::getFormattedDescVars()

Parameters:

Converter &$c

[ Top ]

method getOverridingVarsForClass [line 1552]

array getOverridingVarsForClass(
Converter
&$c, parserClass
&$class)

Tags:

return: an array of parserVars from ALL child classes that override this var in the given class

Parameters:

Converter &$c

parserClass &$class

[ Top ]

method setModifiers [line 1457]

string setModifiers(
$m)

Return name of the class that contains this method

Parameters:

$m

[ Top ]

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