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

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserGlobal

Author(s):

Greg Beaver <cellog@php.net>

Version:

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

Copyright:

2002-2008 Gregory Beaver

Inherited Variables

Class: parserElement

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

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

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.1

[ Top ]

Class Variables

$datatype = 'mixed'

[line 229]

Name of the global's data type

Type:

string

[ Top ]

$type = 'global'

[line 223]

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

Tags:

var:

always 'global'

Type:	string
Overrides:	Array

[ Top ]

Class Methods

method getConflicts [line 251]

mixed getConflicts(
Converter
&$c)

Returns all global variables in other packages that have the same name as this global variable

Tags:

return:	false or an array Format: (package => parserGlobal of conflicting global variable)
usedby:	Converter::getFormattedConflicts()

Parameters:

Converter

&$c

[ Top ]

method getDataType [line 277]

string getDataType(
Converter
&$converter)

Retrieve converter-specific representation of the data type

If the data type is a documented class name, then this function will return a Converter-specific link to that class's documentation, so users can click/browse to the documentation directly from the global variable declaration

Parameters:

Converter

&$converter

[ Top ]

method getLink [line 237]

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

quick way to link to this element

Tags:

return:

converter-specific link to this global variable

Parameters:

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

[ Top ]

method setDataType [line 262]

void setDataType(
string
$type)

Sets the name of the global variable's type

Parameters:

string

$type

[ Top ]

PHP5

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

Nov 21
Docs For Class parserGlobal

Class: parserGlobal

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: parserElement

Class: parserBase

Inherited Methods

Class: parserElement

Class: parserBase

Class Details

Tags:

Class Variables

$datatype = 'mixed'

$type = 'global'

Tags:

Class Methods

method getConflicts [line 251]

Tags:

Parameters:

method getDataType [line 277]

Parameters:

method getLink [line 237]

Tags:

Parameters:

method setDataType [line 262]

Parameters:

PHP5

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

Nov 21Docs For Class parserGlobal

Class: parserGlobal

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: parserElement

Class: parserBase

Inherited Methods

Class: parserElement

Class: parserBase

Class Details

Tags:

Class Variables

$datatype = 'mixed'

$type = 'global'

Tags:

Class Methods

method getConflicts [line 251]

Tags:

Parameters:

method getDataType [line 277]

Parameters:

method getLink [line 237]

Tags:

Parameters:

method setDataType [line 262]

Parameters:

Nov 21
Docs For Class parserGlobal