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

Source Location: /phpDocumentor/Setup.inc.php

Class Overview

Variables

Methods

Class Details

[line 100]

[ Top ]

Class Variables

$dirs = ''

[line 133]

contents of --directory commandline

Tags:

tutorial:

-d, --directory

Type:

string

[ Top ]

$files = ''

[line 127]

contents of --filename commandline

Tags:

tutorial:

-f, --filename

Type:

string

[ Top ]

$setup =

[line 111]

Used to parse command-line options

Type:

[ Top ]

Class Methods

constructor phpDocumentor_setup [line 162]

phpDocumentor_setup phpDocumentor_setup(
)

Checks PHP version, makes sure it is 4.2.0+, and chooses the

phpDocumentorTParser if version is 4.3.0+

Tags:

uses:

phpDocumentor_setup::parseIni()

[ Top ]

method checkIgnoreTag [line 404]

void checkIgnoreTag(

$tagname, [
$inline = false])

Parameters:

	$tagname
	$inline

[ Top ]

method createDocs [line 537]

void createDocs(
[
$title = false])

Parameters:

$title

[ Top ]

method parseHiddenFiles [line 520]

void parseHiddenFiles(
[
$flag = true])

Parameters:

$flag

[ Top ]

method parseIni [line 778]

void parseIni(
)

Parse configuration file phpDocumentor.ini

Tags:

usedby:

phpDocumentor_setup::phpDocumentor_setup()

[ Top ]

method readCommandLineSettings [line 267]

void readCommandLineSettings(
)

Get phpDocumentor settings from command-line or web interface

[ Top ]

method readConfigFile [line 233]

void readConfigFile(
string
$file)

Get phpDocumentor settings from a user configuration file

Parameters:

string

$file

user configuration file

[ Top ]

method setDirectoriesToParse [line 515]

void setDirectoriesToParse(

$dirs)

Parameters:

$dirs

[ Top ]

method setFilesToParse [line 510]

void setFilesToParse(

$files)

Parameters:

$files

[ Top ]

method setIgnore [line 525]

void setIgnore(

$ig)

Parameters:

$ig

[ Top ]

method setJavadocDesc [line 469]

void setJavadocDesc(
)

[ Top ]

method setMemoryLimit [line 417]

void setMemoryLimit(
)

Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit

Tags:

todo:

recognize "K" and "G" in memory_limit settings, rather than just "M"

[ Top ]

method setPackageOutput [line 499]

void setPackageOutput(

$po)

Parameters:

$po

[ Top ]

method setParsePrivate [line 474]

void setParsePrivate(
[
$flag = true])

Parameters:

$flag

[ Top ]

method setQuietMode [line 479]

void setQuietMode(
[
$flag = true])

Parameters:

$flag

[ Top ]

method setTargetDir [line 489]

void setTargetDir(

$target)

Parameters:

$target

[ Top ]

method setTemplateBase [line 494]

void setTemplateBase(

$dir)

Parameters:

$dir

[ Top ]

method setTitle [line 505]

void setTitle(

$ti)

Parameters:

$ti

[ Top ]

method setUndocumentedElementWarnings [line 484]

void setUndocumentedElementWarnings(
[
$flag = true])

Parameters:

$flag

[ Top ]

PHP5

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

Dec 21Docs For Class phpDocumentor_setup

Class: phpDocumentor_setup

Class Overview

Variables

Methods

Class Details

Class Variables

$dirs = ''

Tags:

$files = ''

Tags:

$hidden = false

Tags:

$ignoresymlinks = false

$ignore_files = array()

Tags:

$packages = false

$parse =

$render = false

$setup =

Class Methods

constructor phpDocumentor_setup [line 162]

Tags:

method checkIgnoreTag [line 404]

Parameters:

method createDocs [line 537]

Parameters:

method parseHiddenFiles [line 520]

Parameters:

method parseIni [line 778]

Tags:

method readCommandLineSettings [line 267]

method readConfigFile [line 233]

Parameters:

method setDirectoriesToParse [line 515]

Parameters:

method setFilesToParse [line 510]

Parameters:

method setIgnore [line 525]

Parameters:

method setJavadocDesc [line 469]

method setMemoryLimit [line 417]

Tags:

method setPackageOutput [line 499]

Parameters:

method setParsePrivate [line 474]

Parameters:

method setQuietMode [line 479]

Parameters:

method setTargetDir [line 489]

Parameters:

method setTemplateBase [line 494]

Parameters:

method setTitle [line 505]

Parameters:

method setUndocumentedElementWarnings [line 484]

Parameters:

Dec 21
Docs For Class phpDocumentor_setup