Docs For Class phpDocumentor

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

$hidden = false

[line 139]

contents of --hidden commandline

Tags:

tutorial:

-dh, --hidden

Type:

boolean

[ Top ]

$ignoresymlinks = false

[line 155]

contents of --ignoresymlinks commandline

Type:

boolean

[ Top ]

$ignore_files = array()

[line 150]

contents of --ignore commandline

Tags:

tutorial:

-i, --ignore

Type:

string

[ Top ]

$packages = false

[line 121]

Packages to create documentation for

Type:

string

[ Top ]

$parse =

[line 106]

The main parser

Type:

Parser|phpDocumentorTParser

[ Top ]

$render = false

[line 116]

Used to organize output from the Parser before Conversion

Type:

phpDocumentor_IntermediateParser

[ Top ]

$setup =

[line 111]

Used to parse command-line options

Type:

[ Top ]

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

void checkIgnoreTag(

$tagname, [
$inline = false])

Parameters:

	$tagname
	$inline

[ Top ]

method createDocs [line 530]

void createDocs(
[
$title = false])

Parameters:

$title

[ Top ]

method parseHiddenFiles [line 513]

void parseHiddenFiles(
[
$flag = true])

Parameters:

$flag

[ Top ]

method parseIni [line 771]

void parseIni(
)

Parse configuration file phpDocumentor.ini

Tags:

usedby:

phpDocumentor_setup::phpDocumentor_setup()

[ Top ]

method readCommandLineSettings [line 260]

void readCommandLineSettings(
)

Get phpDocumentor settings from command-line or web interface

[ Top ]

method readConfigFile [line 226]

void readConfigFile(
string
$file)

Get phpDocumentor settings from a user configuration file

Parameters:

string

$file

user configuration file

[ Top ]

method setDirectoriesToParse [line 508]

void setDirectoriesToParse(

$dirs)

Parameters:

$dirs

[ Top ]

method setFilesToParse [line 503]

void setFilesToParse(

$files)

Parameters:

$files

[ Top ]

method setIgnore [line 518]

void setIgnore(

$ig)

Parameters:

$ig

[ Top ]

method setJavadocDesc [line 462]

void setJavadocDesc(
)

[ Top ]

method setMemoryLimit [line 410]

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

void setPackageOutput(

$po)

Parameters:

$po

[ Top ]

method setParsePrivate [line 467]

void setParsePrivate(
[
$flag = true])

Parameters:

$flag

[ Top ]

method setQuietMode [line 472]

void setQuietMode(
[
$flag = true])

Parameters:

$flag

[ Top ]

method setTargetDir [line 482]

void setTargetDir(

$target)

Parameters:

$target

[ Top ]

method setTemplateBase [line 487]

void setTemplateBase(

$dir)

Parameters:

$dir

[ Top ]

method setTitle [line 498]

void setTitle(

$ti)

Parameters:

$ti

[ Top ]

method setUndocumentedElementWarnings [line 477]

void setUndocumentedElementWarnings(
[
$flag = true])

Parameters:

$flag

[ Top ]

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

Parameters:

method createDocs [line 530]

Parameters:

method parseHiddenFiles [line 513]

Parameters:

method parseIni [line 771]

Tags:

method readCommandLineSettings [line 260]

method readConfigFile [line 226]

Parameters:

method setDirectoriesToParse [line 508]

Parameters:

method setFilesToParse [line 503]

Parameters:

method setIgnore [line 518]

Parameters:

method setJavadocDesc [line 462]

method setMemoryLimit [line 410]

Tags:

method setPackageOutput [line 492]

Parameters:

method setParsePrivate [line 467]

Parameters:

method setQuietMode [line 472]

Parameters:

method setTargetDir [line 482]

Parameters:

method setTemplateBase [line 487]

Parameters:

method setTitle [line 498]

Parameters:

method setUndocumentedElementWarnings [line 477]

Parameters: