Class: phpDocumentor_setup

Source Location: /phpDocumentor/Setup.inc.php

Class phpDocumentor_setup

Class Overview

Located in /phpDocumentor/Setup.inc.php [line 99]

Property Summary

string	$dirs	contents of --directory commandline
string	$files	contents of --filename commandline
boolean	$hidden	contents of --hidden commandline
boolean	$ignoresymlinks	contents of --ignoresymlinks commandline
string	$ignore_files	contents of --ignore commandline
string	$packages	Packages to create documentation for
Parser\|phpDocumentorTParser	$parse	The main parser
phpDocumentor_IntermediateParser	$render	Used to organize output from the Parser before Conversion
Io	$setup	Used to parse command-line options

[ Top ]

Method Summary

phpDocumentor_setup	phpDocumentor_setup()	Checks PHP version, makes sure it is 4.2.0+, and chooses the
void	checkIgnoreTag()
void	createDocs()
void	parseHiddenFiles()
void	parseIni()	Parse configuration file phpDocumentor.ini
void	readCommandLineSettings()	Get phpDocumentor settings from command-line or web interface
void	readConfigFile()	Get phpDocumentor settings from a user configuration file
void	setDirectoriesToParse()
void	setFilesToParse()
void	setIgnore()
void	setJavadocDesc()
void	setMemoryLimit()	Allow a memory_limit setting in phpDocumentor.ini to override php.ini or default memory limit
void	setPackageOutput()
void	setParsePrivate()
void	setQuietMode()
void	setTargetDir()
void	setTemplateBase()
void	setTitle()
void	setUndocumentedElementWarnings()

[ Top ]

Properties

string $dirs = '' [line 132]

contents of --directory commandline

Information Tags:

Tutorial:

-d, --directory

[ Top ]

string $files = '' [line 126]

contents of --filename commandline

Information Tags:

Tutorial:

-f, --filename

[ Top ]

boolean $hidden = false [line 138]

contents of --hidden commandline

Information Tags:

Tutorial:

-dh, --hidden

[ Top ]

boolean $ignoresymlinks = false [line 154]

contents of --ignoresymlinks commandline

[ Top ]

string $ignore_files = array() [line 149]

contents of --ignore commandline

Information Tags:

Tutorial:

-i, --ignore

[ Top ]

string $packages = false [line 120]

Packages to create documentation for

[ Top ]

Parser|phpDocumentorTParser $parse [line 105]

The main parser

[ Top ]

phpDocumentor_IntermediateParser $render = false [line 115]

Used to organize output from the Parser before Conversion

[ Top ]

Io $setup [line 110]

Used to parse command-line options

[ Top ]

Methods

Constructor phpDocumentor_setup [line 161]

phpDocumentor_setup phpDocumentor_setup(
)

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

phpDocumentorTParser if version is 4.3.0+

API Tags:

Uses:

phpDocumentor_setup::parseIni()

[ Top ]

checkIgnoreTag [line 406]

void checkIgnoreTag(

$tagname, [
$inline = false] 
)

Parameters:

	$tagname:
	$inline:

[ Top ]

createDocs [line 539]

void createDocs(
[
$title = false] 
)

Parameters:

$title:

[ Top ]

parseHiddenFiles [line 522]

void parseHiddenFiles(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

parseIni [line 780]

void parseIni(
)

Parse configuration file phpDocumentor.ini

API Tags:

Usedby:

phpDocumentor_setup::phpDocumentor_setup()

[ Top ]

readCommandLineSettings [line 268]

void readCommandLineSettings(
)

Get phpDocumentor settings from command-line or web interface

[ Top ]

readConfigFile [line 234]

void readConfigFile(
string
$file 
)

Get phpDocumentor settings from a user configuration file

Parameters:

string

$file:

user configuration file

[ Top ]

setDirectoriesToParse [line 517]

void setDirectoriesToParse(

$dirs 
)

Parameters:

$dirs:

[ Top ]

setFilesToParse [line 512]

void setFilesToParse(

$files 
)

Parameters:

$files:

[ Top ]

setIgnore [line 527]

void setIgnore(

$ig 
)

Parameters:

$ig:

[ Top ]

setJavadocDesc [line 471]

void setJavadocDesc(
)

[ Top ]

setMemoryLimit [line 419]

void setMemoryLimit(
)

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

Information Tags:

Todo:

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

[ Top ]

setPackageOutput [line 501]

void setPackageOutput(

$po 
)

Parameters:

$po:

[ Top ]

setParsePrivate [line 476]

void setParsePrivate(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

setQuietMode [line 481]

void setQuietMode(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

setTargetDir [line 491]

void setTargetDir(

$target 
)

Parameters:

$target:

[ Top ]

setTemplateBase [line 496]

void setTemplateBase(

$dir 
)

Parameters:

$dir:

[ Top ]

setTitle [line 507]

void setTitle(

$ti 
)

Parameters:

$ti:

[ Top ]

setUndocumentedElementWarnings [line 486]

void setUndocumentedElementWarnings(
[
$flag = true] 
)

Parameters:

$flag:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:21:14 -0600 by phpDocumentor 1.4.4

	phpDocumentor

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]