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

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserFunction

Author(s):

Greg Beaver <cellog@php.net>

Version:

$Id: ParserElements.inc 248547 2007-12-19 02:16:49Z ashnazg $

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Child classes:

parserMethod

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 321]

Tags:

author:	Greg Beaver <cellog@php.net>
version:	$Id: ParserElements.inc 248547 2007-12-19 02:16:49Z ashnazg $
copyright:	2002-2008 Gregory Beaver
since:	1.0rc1

[ Top ]

Class Variables

$globals = false

[line 351]

global declarations parsed from function definition

Tags:

var:

Format: array(globalname1, globalname2,....)

Type:

array

[ Top ]

$params = false

[line 335]

parameters parsed from function definition.

param name may be null, in which case, updateParams() must be called from the Converter

Tags:

var:	Format: array(param name => default value parsed from function definition)
see:	updateParams()

Type:

array

[ Top ]

$returnsreference = false

[line 345]

Function returns a reference to an element, instead of a value

set to true if function is declared as:

function &func(...

Type:

boolean

[ Top ]

$source = ''

[line 358]

Type:

mixed

[ Top ]

$statics = false

[line 356]

static variable declarations parsed from function definition

Tags:

var:

Format: array(array('name' => staticvar1,'val' => '' or default val of staticvar1),...)

Type:

array

[ Top ]

$type = 'function'

[line 327]

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

Tags:

var:

always 'function'

Type:	string
Overrides:	Array

[ Top ]

Class Methods

method addGlobals [line 433]

void addGlobals(
array
$globals)

Add all "global $var, $var2" declarations to this function

Parameters:

array

$globals

Format: array(globalname1, globalname2,....)

[ Top ]

method addParam [line 366]

void addParam(
string
$name, string
$value, [boolean
$has_default = true], [null|string
$typehint = null])

Overridden in child classes as:

parserMethod::addParam()

Parameters:

string	$name
string	$value	default value parsed from function definition
boolean	$has_default	indicates whether this parameter has a default value
null\|string	$typehint	class type hint

[ Top ]

method addSource [line 379]

void addSource(
string|array
$source)

Set the source code. Always array in PHP 4.3.0+

Parameters:

string|array

$source

[ Top ]

method addStatics [line 443]

void addStatics(
array
$static, array
$vals)

Add all "static $var, $var2 = 6" declarations to this function

Parameters:

array	$static	Format: array(varname1, varname2,...)
array	$vals	Format: array(default val of var 1, default val of var 2,...) if var 1 has no default, array(default val of var 2,...)

[ Top ]

method getConflicts [line 422]

mixed getConflicts(
Converter
&$c)

Returns all functions in other packages that have the same name as this function

Tags:

return:	false or an array Format: (package => parserFunction of conflicting functions)
usedby:	Converter::getFormattedConflicts()

Parameters:

Converter

&$c

[ Top ]

method getFunctionCall [line 580]

string getFunctionCall(
)

Get a human-friendly description of the function call

takes declaration like:

and returns: string &func( $param1, [$param2 = 6], [$param3 = array('20',9 => "heroo")] )

method getIntricateFunctionCall [line 621]

array getIntricateFunctionCall(

$converter, 
$paramtags)

Like getFunctionCall(), but has no English or pre-determined formatting.

Much more flexible.

Tags:

return:	Format: array('name' => function name, 'returnsref' => boolean if declared as "function &name()" 'params' => array('type' => data type of parameter, 'description' => from @param tag, 'name' => variable name, 'default' => default value if any))
see:	parserFunction::getFunctionCall()

Overridden in child classes as:

parserMethod::getIntricateFunctionCall()

Parameters:

	$converter
	$paramtags

[ Top ]

method getLink [line 408]

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

quick way to link to this element

Parameters:

Converter	$c
string	$text	text to display for the link or false for default text
	$returnobj

[ Top ]

method getParam [line 464]

string getParam(
string
$name)

Tags:

return:

default value of param $name

Parameters:

string

$name

[ Top ]

method getReturnsReference [line 561]

boolean getReturnsReference(
)

Tags:

return:

returns value of $returnsreference

[ Top ]

method getSource [line 397]

string|array getSource(
)

Tags:

return:

source code ready for highlighting

[ Top ]

method hasSource [line 388]

boolean hasSource(
)

Determine whether the source code has been requested via {@source}

[ Top ]

method listGlobals [line 515]

array listGlobals(
)

Tags:

return:

format: array(array(index, globalname),...)

[ Top ]

method listParams [line 480]

array listParams(
)

Tags:

return:

format: array(array(paramname, default value),...)

[ Top ]

method listStatics [line 534]

array listStatics(
)

Tags:

return:

format: array(array(static var name, static var default value),...)

[ Top ]

method setReturnsReference [line 553]

void setReturnsReference(
)

sets $returnsreference to true

[ Top ]

PHP5

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

Dec 21Docs For Class parserFunction

Class: parserFunction

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: parserElement

Class: parserBase

Inherited Methods

Class: parserElement

Class: parserBase

Class Details

Tags:

Class Variables

$globals = false

Tags:

$params = false

Tags:

$returnsreference = false

$source = ''

$statics = false

Tags:

$type = 'function'

Tags:

Class Methods

method addGlobals [line 433]

Parameters:

method addParam [line 366]

Parameters:

method addSource [line 379]

Parameters:

method addStatics [line 443]

Parameters:

method getConflicts [line 422]

Tags:

Parameters:

method getFunctionCall [line 580]

Tags:

method getIntricateFunctionCall [line 621]

Tags:

Parameters:

method getLink [line 408]

Tags:

Parameters:

method getParam [line 464]

Tags:

Parameters:

method getReturnsReference [line 561]

Tags:

method getSource [line 397]

Tags:

method hasSource [line 388]

method listGlobals [line 515]

Tags:

method listParams [line 480]

Tags:

method listStatics [line 534]

Tags:

method setReturnsReference [line 553]

Dec 21
Docs For Class parserFunction