phpDocumentor phpDocumentor

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

phpDocumentor

FAQ

ChangeLog

INSTALL

README

Todo List

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

DescHTML
DescHTML.inc

DocBlockTags
DocBlockTags.inc

Errors
Errors.inc

InlineTags
InlineTags.inc

Links
LinkClasses.inc

ParserData
ParserData.inc

ParserDocBlock
ParserDocBlock.inc

ParserElements
ParserElements.inc

Parsers
Beautifier.php
HighlightParser.inc
Parser.inc
phpDocumentorTParser.inc
Tokenizer.php
TutorialHighlightParser.inc
XMLpackagePageParser.inc

setup
find_phpdoc.php

Tutorial
PackagePageElements.inc

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

Source Location: /phpDocumentor/Setup.inc.php

Class phpDocumentor_setup

Class Overview

Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

[ Top ]

Property Summary

Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

string $dirs contents of --directory commandline

string $files contents of --filename commandline

boolean $hidden contents of --hidden commandline

boolean $ignoresymlinks contents of --ignoresymlinks commandline

string $ignore_files contents of --ignore commandline

string $packages Packages to create documentation for

Parser|phpDocumentorTParser $parse The main parser

phpDocumentor_IntermediateParser $render Used to organize output from the Parser before Conversion

Io $setup Used to parse command-line options

[ Top ]

Method Summary

Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

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

void checkIgnoreTag()

void createDocs()

void parseHiddenFiles()

void parseIni() Parse configuration file phpDocumentor.ini

void readCommandLineSettings() Get phpDocumentor settings from command-line or web interface

void readConfigFile() Get phpDocumentor settings from a user configuration file

void setDirectoriesToParse()

void setFilesToParse()

void setIgnore()

void setJavadocDesc()

void setMemoryLimit() Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit

void setPackageOutput()

void setParsePrivate()

void setQuietMode()

void setTargetDir()

void setTemplateBase()

void setTitle()

void setUndocumentedElementWarnings()

[ Top ]

Properties

Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

string $dirs = '' [line 132]

contents of --directory commandline

Information Tags:

Tutorial: -d, --directory

[ Top ]

string $files = '' [line 126]

contents of --filename commandline

Information Tags:

Tutorial: -f, --filename

[ Top ]

boolean $hidden = false [line 138]

contents of --hidden commandline

Information Tags:

Tutorial: -dh, --hidden

[ Top ]

boolean $ignoresymlinks = false [line 154]

contents of --ignoresymlinks commandline

[ Top ]

string $ignore_files = array() [line 149]

contents of --ignore commandline

Information Tags:

Tutorial: -i, --ignore

[ Top ]

string $packages = false [line 120]

Packages to create documentation for

[ Top ]

Parser|phpDocumentorTParser $parse [line 105]

The main parser

[ Top ]

phpDocumentor_IntermediateParser $render = false [line 115]

Used to organize output from the Parser before Conversion

[ Top ]

Io $setup [line 110]

Used to parse command-line options

[ Top ]

Methods

Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

Constructor phpDocumentor_setup [line 161]

phpDocumentor_setup phpDocumentor_setup(
)

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

phpDocumentorTParser if version is 4.3.0+

API Tags:

Uses: phpDocumentor_setup::parseIni()

[ Top ]

checkIgnoreTag [line 406]

void checkIgnoreTag(
$tagname, [
$inline = false] 
)

Parameters:

$tagname:

$inline:

[ Top ]

createDocs [line 539]

void createDocs(
[
$title = false] 
)

Parameters:

$title:

[ Top ]

parseHiddenFiles [line 522]

void parseHiddenFiles(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

parseIni [line 780]

void parseIni(
)

Parse configuration file phpDocumentor.ini

API Tags:

Usedby: phpDocumentor_setup::phpDocumentor_setup()

[ Top ]

readCommandLineSettings [line 268]

void readCommandLineSettings(
)

Get phpDocumentor settings from command-line or web interface

[ Top ]

readConfigFile [line 234]

void readConfigFile(
string
$file 
)

Get phpDocumentor settings from a user configuration file

Parameters:

string $file: user configuration file

[ Top ]

setDirectoriesToParse [line 517]

void setDirectoriesToParse(
$dirs 
)

Parameters:

$dirs:

[ Top ]

setFilesToParse [line 512]

void setFilesToParse(
$files 
)

Parameters:

$files:

[ Top ]

setIgnore [line 527]

void setIgnore(
$ig 
)

Parameters:

$ig:

[ Top ]

setJavadocDesc [line 471]

void setJavadocDesc(
)

[ Top ]

setMemoryLimit [line 419]

void setMemoryLimit(
)

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

Information Tags:

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

[ Top ]

setPackageOutput [line 501]

void setPackageOutput(
$po 
)

Parameters:

$po:

[ Top ]

setParsePrivate [line 476]

void setParsePrivate(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

setQuietMode [line 481]

void setQuietMode(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

setTargetDir [line 491]

void setTargetDir(
$target 
)

Parameters:

$target:

[ Top ]

setTemplateBase [line 496]

void setTemplateBase(
$dir 
)

Parameters:

$dir:

[ Top ]

setTitle [line 507]

void setTitle(
$ti 
)

Parameters:

$ti:

[ Top ]

setUndocumentedElementWarnings [line 486]

void setUndocumentedElementWarnings(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

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