Class: phpDocumentor_setup

[line 132]

contents of --directory commandline

Tags:

• tutorial - -d, --directory

Type: string

Overrides:

[line 126]

contents of --filename commandline

Tags:

• tutorial - -f, --filename

Type: string

Overrides:

[line 138]

contents of --hidden commandline

Tags:

• tutorial - -dh, --hidden

Type: boolean

Overrides:

[line 154]

contents of --ignoresymlinks commandline

Type: boolean

Overrides:

[line 149]

contents of --ignore commandline

Tags:

• tutorial - -i, --ignore

Type: string

Overrides:

[line 120]

Packages to create documentation for

Type: string

Overrides:

[line 105]

The main parser

Type: Parser|phpDocumentorTParser

Overrides:

[line 115]

Used to organize output from the Parser before Conversion

Type: phpDocumentor_IntermediateParser

Overrides:

[line 110]

Used to parse command-line options

Type: Io

Overrides:

phpDocumentor_setup phpDocumentor_setup( )

[line 161]

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()

Parameters:

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

[line 406]

Parameters:

• $tagname -
• $inline -

void createDocs( [ $title = false])

[line 539]

Parameters:

• $title -

void parseHiddenFiles( [ $flag = true])

[line 522]

Parameters:

• $flag -

void parseIni( )

[line 780]

Parse configuration file phpDocumentor.ini

Tags:

• usedby - phpDocumentor_setup::phpDocumentor_setup()

Parameters:

void readCommandLineSettings( )

[line 268]

Get phpDocumentor settings from command-line or web interface

Parameters:

void readConfigFile( string $file)

[line 234]

Get phpDocumentor settings from a user configuration file

Parameters:

• string $file - user configuration file

void setDirectoriesToParse( $dirs)

[line 517]

Parameters:

• $dirs -

void setFilesToParse( $files)

[line 512]

Parameters:

• $files -

void setIgnore( $ig)

[line 527]

Parameters:

• $ig -

void setJavadocDesc( )

[line 471]

Parameters:

void setMemoryLimit( )

[line 419]

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"

Parameters:

void setPackageOutput( $po)

[line 501]

Parameters:

• $po -

void setParsePrivate( [ $flag = true])

[line 476]

Parameters:

• $flag -

void setQuietMode( [ $flag = true])

[line 481]

Parameters:

• $flag -

void setTargetDir( $target)

[line 491]

Parameters:

• $target -

void setTemplateBase( $dir)

[line 496]

Parameters:

• $dir -

void setTitle( $ti)

[line 507]

Parameters:

• $ti -

void setUndocumentedElementWarnings( [ $flag = true])

[line 486]

Parameters:

• $flag -