Docs For Class phpDocumentor

$dirs = ''

[line 130]

contents of --directory commandline

Tutorial: -d, --directory

Type:

string

[ Top ]

$files = ''

[line 124]

contents of --filename commandline

Tutorial: -f, --filename

Type:

string

[ Top ]

$hidden = false

[line 136]

contents of --hidden commandline

Tutorial: -h, --hidden

Type:

boolean

[ Top ]

$ignore_files = array()

[line 147]

contents of --ignore commandline

Tutorial: -i, --ignore

Type:

string

[ Top ]

$packages = false

[line 118]

Packages to create documentation for

Type:

string

[ Top ]

$parse =

[line 103]

The main parser

Type:

Parser|phpDocumentorTParser

[ Top ]

$render = false

[line 113]

Used to organize output from the Parser before Conversion

Type:

phpDocumentor_IntermediateParser

[ Top ]

$setup =

[line 108]

Used to parse command-line options

Type:

[ Top ]

phpDocumentor_setup (Constructor) [line 153]

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

void checkIgnoreTag(

$tagname, [
$inline = false])

Parameters:

	`$tagname`	—
	`$inline`	—

[ Top ]

cleanConverterNamePiece [line 744]

void cleanConverterNamePiece(

$name, [
$extra_characters_to_allow = ''])

Parameters:

	`$name`	—
	`$extra_characters_to_allow`	—

[ Top ]

createDocs [line 451]

void createDocs(
[
$title = false])

Parameters:

$title —

[ Top ]

parseHiddenFiles [line 434]

void parseHiddenFiles(
[
$flag = true])

Parameters:

$flag —

[ Top ]

parseIni [line 691]

void parseIni(
)

Parse configuration file phpDocumentor.ini

Usedby: phpDocumentor_setup::phpDocumentor_setup()

[ Top ]

readCommandLineSettings [line 248]

void readCommandLineSettings(
)

Get phpDocumentor settings from command-line or web interface

[ Top ]

readConfigFile [line 214]

void readConfigFile(
string
$file)

Get phpDocumentor settings from a user configuration file

Parameters:

string $file — user configuration file

[ Top ]

setDirectoriesToParse [line 429]

void setDirectoriesToParse(

$dirs)

Parameters:

$dirs —

[ Top ]

setFilesToParse [line 424]

void setFilesToParse(

$files)

Parameters:

$files —

[ Top ]

setIgnore [line 439]

void setIgnore(

$ig)

Parameters:

$ig —

[ Top ]

setJavadocDesc [line 388]

void setJavadocDesc(
)

[ Top ]

setPackageOutput [line 413]

void setPackageOutput(

$po)

Parameters:

$po —

[ Top ]

setParsePrivate [line 393]

void setParsePrivate(
[
$flag = true])

Parameters:

$flag —

[ Top ]

setQuietMode [line 398]

void setQuietMode(
[
$flag = true])

Parameters:

$flag —

[ Top ]

setTargetDir [line 403]

void setTargetDir(

$target)

Parameters:

$target —

[ Top ]

setTemplateBase [line 408]

void setTemplateBase(

$dir)

Parameters:

$dir —

[ Top ]

setTitle [line 419]

void setTitle(

$ti)

Parameters:

$ti —

[ Top ]

setupConverters [line 755]

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

$ignore_files = array()

$packages = false

$parse =

$render = false

$setup =

Method Detail

phpDocumentor_setup (Constructor) [line 153]

checkIgnoreTag [line 379]

Parameters:

cleanConverterNamePiece [line 744]

Parameters:

createDocs [line 451]

Parameters:

parseHiddenFiles [line 434]

Parameters:

parseIni [line 691]

readCommandLineSettings [line 248]

readConfigFile [line 214]

Parameters:

setDirectoriesToParse [line 429]

Parameters:

setFilesToParse [line 424]

Parameters:

setIgnore [line 439]

Parameters:

setJavadocDesc [line 388]

setPackageOutput [line 413]

Parameters:

setParsePrivate [line 393]

Parameters:

setQuietMode [line 398]

Parameters:

setTargetDir [line 403]

Parameters:

setTemplateBase [line 408]

Parameters:

setTitle [line 419]

Parameters:

setupConverters [line 755]

Parameters: