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

Source Location: /phpDocumentor/ParserDocBlock.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserDesc

represents a short or long description in a DocBlock (parserDocBlock)

Author(s):

Greg Beaver <cellog@php.net>

Version:

$Id: ParserDocBlock.inc 287886 2009-08-30 05:31:05Z ashnazg $

Copyright:

2002-2008 Gregory Beaver

Variables

$type

Methods

Inherited Variables

Class: parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited Methods

Class: parserStringWithInlineTags

parserStringWithInlineTags::add(): equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert(): Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString(): return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag(): Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource(): Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen(): equivalent to trim(strlen($string))

Class: parserBase

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

Class Details

[line 47]
represents a short or long description in a DocBlock (parserDocBlock)

Tags:

author:	Greg Beaver <cellog@php.net>
version:	$Id: ParserDocBlock.inc 287886 2009-08-30 05:31:05Z ashnazg $
copyright:	2002-2008 Gregory Beaver
since:	1.0rc1

[ Top ]

Class Variables

$type = '_desc'

[line 54]

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

always '_desc'

Type:	string
Overrides:	Array

[ Top ]

Class Methods

method add [line 60]

void add(
mixed
$stringOrClass)

Overrides parserStringWithInlineTags::add() (equivalent to the . operator ($a = $b . $c))

Parameters:

mixed

$stringOrClass

like parserStringWithInlineTags::add(), this can be a string or parserInlineTag, but it can also be a parserStringWithInlineTags, and the contents will be merged

[ Top ]

method hasInheritDoc [line 81]

boolean hasInheritDoc(
)

Tags:

return:

whether this desc has an {@inheritdoc} inline tag

[ Top ]

method hasSource [line 92]

boolean hasSource(
)

Tags:

return:

whether this desc has an {@source} inline tag

[ Top ]

method replaceInheritDoc [line 104]

void replaceInheritDoc(
parserDesc
$desc)

replaces {@inheritdoc} with the contents of the parent DocBlock

Parameters:

parserDesc

$desc

parent parserDesc, used to retrieve the description

[ Top ]

PHP5

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

Dec 21
Docs For Class parserDesc

Class: parserDesc

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: parserStringWithInlineTags

Inherited Methods

Class: parserStringWithInlineTags

Class: parserBase

Class Details

Tags:

Class Variables

$type = '_desc'

Class Methods

method add [line 60]

Parameters:

method hasInheritDoc [line 81]

Tags:

method hasSource [line 92]

Tags:

method replaceInheritDoc [line 104]

Parameters:

PHP5

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

Dec 21Docs For Class parserDesc

Class: parserDesc

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: parserStringWithInlineTags

Inherited Methods

Class: parserStringWithInlineTags

Class: parserBase

Class Details

Tags:

Class Variables

$type = '_desc'

Class Methods

method add [line 60]

Parameters:

method hasInheritDoc [line 81]

Tags:

method hasSource [line 92]

Tags:

method replaceInheritDoc [line 104]

Parameters:

Dec 21
Docs For Class parserDesc