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


Tutorials/Manuals:
Package-level: 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

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
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 Details

[line 99]


[ Top ]


Class Variables

$dirs = ''

[line 132]

contents of --directory commandline



Tags:

tutorial: -d, --directory

Type: string


[ Top ]

$files = ''

[line 126]

contents of --filename commandline



Tags:

tutorial: -f, --filename

Type: string


[ Top ]

$hidden = false

[line 138]

contents of --hidden commandline



Tags:

tutorial: -dh, --hidden

Type: boolean


[ Top ]

$ignoresymlinks = false

[line 154]

contents of --ignoresymlinks commandline


Type: boolean


[ Top ]

$ignore_files = array()

[line 149]

contents of --ignore commandline



Tags:

tutorial: -i, --ignore

Type: string


[ Top ]

$packages = false

[line 120]

Packages to create documentation for


Type: string


[ Top ]

$parse =

[line 105]

The main parser




[ Top ]

$render = false

[line 115]

Used to organize output from the Parser before Conversion




[ Top ]

$setup =

[line 110]

Used to parse command-line options


Type: Io


[ Top ]



Class Methods


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+




Tags:



[ Top ]

method checkIgnoreTag [line 406]

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



Parameters:

$tagname
$inline

[ Top ]

method createDocs [line 539]

void createDocs( [ $title = false])



Parameters:

$title

[ Top ]

method parseHiddenFiles [line 522]

void parseHiddenFiles( [ $flag = true])



Parameters:

$flag

[ Top ]

method parseIni [line 780]

void parseIni( )

Parse configuration file phpDocumentor.ini



Tags:



[ Top ]

method readCommandLineSettings [line 268]

void readCommandLineSettings( )

Get phpDocumentor settings from command-line or web interface



[ Top ]

method readConfigFile [line 234]

void readConfigFile( string $file)

Get phpDocumentor settings from a user configuration file



Parameters:

string $file user configuration file

[ Top ]

method setDirectoriesToParse [line 517]

void setDirectoriesToParse( $dirs)



Parameters:

$dirs

[ Top ]

method setFilesToParse [line 512]

void setFilesToParse( $files)



Parameters:

$files

[ Top ]

method setIgnore [line 527]

void setIgnore( $ig)



Parameters:

$ig

[ Top ]

method setJavadocDesc [line 471]

void setJavadocDesc( )



[ Top ]

method setMemoryLimit [line 419]

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

void setPackageOutput( $po)



Parameters:

$po

[ Top ]

method setParsePrivate [line 476]

void setParsePrivate( [ $flag = true])



Parameters:

$flag

[ Top ]

method setQuietMode [line 481]

void setQuietMode( [ $flag = true])



Parameters:

$flag

[ Top ]

method setTargetDir [line 491]

void setTargetDir( $target)



Parameters:

$target

[ Top ]

method setTemplateBase [line 496]

void setTemplateBase( $dir)



Parameters:

$dir

[ Top ]

method setTitle [line 507]

void setTitle( $ti)



Parameters:

$ti

[ Top ]

method setUndocumentedElementWarnings [line 486]

void setUndocumentedElementWarnings( [ $flag = true])



Parameters:

$flag

[ Top ]


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

AltStyle によって変換されたページ (->オリジナル) /