Docs For Class phpDocumentor

$dirs = ''

[line 129]

contents of --directory commandline

Tutorial: -d, --directory

Type:

string

[ Top ]

$files = ''

[line 123]

contents of --filename commandline

Tutorial: -f, --filename

Type:

string

[ Top ]

$hidden = false

[line 135]

contents of --hidden commandline

Tutorial: -dh, --hidden

Type:

boolean

[ Top ]

$ignoresymlinks = false

[line 151]

contents of --ignoresymlinks commandline

Type:

boolean

[ Top ]

$ignore_files = array()

[line 146]

contents of --ignore commandline

Tutorial: -i, --ignore

Type:

string

[ Top ]

$packages = false

[line 117]

Packages to create documentation for

Type:

string

[ Top ]

$parse =

[line 102]

The main parser

Type:

Parser|phpDocumentorTParser

[ Top ]

$render = false

[line 112]

Used to organize output from the Parser before Conversion

Type:

phpDocumentor_IntermediateParser

[ Top ]

$setup =

[line 107]

Used to parse command-line options

Type:

[ Top ]

phpDocumentor_setup (Constructor) [line 158]

phpDocumentor_setup phpDocumentor_setup(
)

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

phpDocumentorTParser if version is 4.3.0+

Uses: phpDocumentor_setup::parseIni()

[ Top ]

checkIgnoreTag [line 387]

void checkIgnoreTag(

$tagname, [
$inline = false])

Parameters:

	`$tagname`	—
	`$inline`	—

[ Top ]

cleanConverterNamePiece [line 815]

void cleanConverterNamePiece(

$name, [
$extra_characters_to_allow = ''])

Parameters:

	`$name`	—
	`$extra_characters_to_allow`	—

[ Top ]

createDocs [line 520]

void createDocs(
[
$title = false])

Parameters:

$title —

[ Top ]

parseHiddenFiles [line 503]

void parseHiddenFiles(
[
$flag = true])

Parameters:

$flag —

[ Top ]

parseIni [line 760]

void parseIni(
)

Parse configuration file phpDocumentor.ini

Usedby: phpDocumentor_setup::phpDocumentor_setup()

[ Top ]

readCommandLineSettings [line 250]

void readCommandLineSettings(
)

Get phpDocumentor settings from command-line or web interface

[ Top ]

readConfigFile [line 216]

void readConfigFile(
string
$file)

Get phpDocumentor settings from a user configuration file

Parameters:

string $file — user configuration file

[ Top ]

setDirectoriesToParse [line 498]

void setDirectoriesToParse(

$dirs)

Parameters:

$dirs —

[ Top ]

setFilesToParse [line 493]

void setFilesToParse(

$files)

Parameters:

$files —

[ Top ]

setIgnore [line 508]

void setIgnore(

$ig)

Parameters:

$ig —

[ Top ]

setJavadocDesc [line 452]

void setJavadocDesc(
)

[ Top ]

setMemoryLimit [line 400]

void setMemoryLimit(
)

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

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

[ Top ]

setPackageOutput [line 482]

void setPackageOutput(

$po)

Parameters:

$po —

[ Top ]

setParsePrivate [line 457]

void setParsePrivate(
[
$flag = true])

Parameters:

$flag —

[ Top ]

setQuietMode [line 462]

void setQuietMode(
[
$flag = true])

Parameters:

$flag —

[ Top ]

setTargetDir [line 472]

void setTargetDir(

$target)

Parameters:

$target —

[ Top ]

setTemplateBase [line 477]

void setTemplateBase(

$dir)

Parameters:

$dir —

[ Top ]

setTitle [line 488]

void setTitle(

$ti)

Parameters:

$ti —

[ Top ]

setUndocumentedElementWarnings [line 467]

void setUndocumentedElementWarnings(
[
$flag = true])

Parameters:

$flag —

[ Top ]

setupConverters [line 826]

void setupConverters(
[
$output = false])

Parameters:

$output —

[ Top ]

Class: phpDocumentor_setup

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$dirs = ''

$files = ''

$hidden = false

$ignoresymlinks = false

$ignore_files = array()

$packages = false

$parse =

$render = false

$setup =

Method Detail

phpDocumentor_setup (Constructor) [line 158]

checkIgnoreTag [line 387]

Parameters:

cleanConverterNamePiece [line 815]

Parameters:

createDocs [line 520]

Parameters:

parseHiddenFiles [line 503]

Parameters:

parseIni [line 760]

readCommandLineSettings [line 250]

readConfigFile [line 216]

Parameters:

setDirectoriesToParse [line 498]

Parameters:

setFilesToParse [line 493]

Parameters:

setIgnore [line 508]

Parameters:

setJavadocDesc [line 452]

setMemoryLimit [line 400]

setPackageOutput [line 482]

Parameters:

setParsePrivate [line 457]

Parameters:

setQuietMode [line 462]

Parameters:

setTargetDir [line 472]

Parameters:

setTemplateBase [line 477]

Parameters:

setTitle [line 488]

Parameters:

setUndocumentedElementWarnings [line 467]

Parameters:

setupConverters [line 826]

Parameters: