$dirs = '' (line 132)

Data type : string

contents of --directory commandline

• tutorial: - -d, --directory

$files = '' (line 126)

Data type : string

contents of --filename commandline

• tutorial: - -f, --filename

$hidden = false (line 138)

Data type : boolean

contents of --hidden commandline

• tutorial: - -dh, --hidden

$ignoresymlinks = false (line 154)

Data type : boolean

contents of --ignoresymlinks commandline

$ignore_files = array() (line 149)

Data type : string

contents of --ignore commandline

• tutorial: - -i, --ignore

$packages = false (line 120)

Data type : string

Packages to create documentation for

$parse (line 105)

Data type : Parser|phpDocumentorTParser

The main parser

$render = false (line 115)

Data type : phpDocumentor_IntermediateParser

Used to organize output from the Parser before Conversion

$setup (line 110)

Data type : Io

Used to parse command-line options

Constructor phpDocumentor_setup (line 161)

phpDocumentor_setup phpDocumentor_setup( )

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

Info

• uses - phpDocumentor_setup::parseIni()

Method checkIgnoreTag (line 406)

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

Parameters

• $tagname:
• $inline:

Info

Method createDocs (line 539)

void createDocs( [ $title = false])

Parameters

• $title:

Info

Method parseHiddenFiles (line 522)

void parseHiddenFiles( [ $flag = true])

Parameters

• $flag:

Info

Method parseIni (line 780)

void parseIni( )

Parse configuration file phpDocumentor.ini

Info

• usedby - phpDocumentor_setup::phpDocumentor_setup()

Method readCommandLineSettings (line 268)

void readCommandLineSettings( )

Get phpDocumentor settings from command-line or web interface

Info

Method readConfigFile (line 234)

void readConfigFile( string $file)

Get phpDocumentor settings from a user configuration file

Parameters

• string $file: user configuration file

Info

Method setDirectoriesToParse (line 517)

void setDirectoriesToParse( $dirs)

Parameters

• $dirs:

Info

Method setFilesToParse (line 512)

void setFilesToParse( $files)

Parameters

• $files:

Info

Method setIgnore (line 527)

void setIgnore( $ig)

Parameters

• $ig:

Info

Method setJavadocDesc (line 471)

void setJavadocDesc( )

Info

Method setMemoryLimit (line 419)

void setMemoryLimit( )

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

Info

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

Method setPackageOutput (line 501)

void setPackageOutput( $po)

Parameters

• $po:

Info

Method setParsePrivate (line 476)

void setParsePrivate( [ $flag = true])

Parameters

• $flag:

Info

Method setQuietMode (line 481)

void setQuietMode( [ $flag = true])

Parameters

• $flag:

Info

Method setTargetDir (line 491)

void setTargetDir( $target)

Parameters

• $target:

Info

Method setTemplateBase (line 496)

void setTemplateBase( $dir)

Parameters

• $dir:

Info

Method setTitle (line 507)

void setTitle( $ti)

Parameters

• $ti:

Info

Method setUndocumentedElementWarnings (line 486)

void setUndocumentedElementWarnings( [ $flag = true])

Parameters

• $flag:

Info