Class phpDocumentor_setup

Description

Located in /phpDocumentor/Setup.inc.php (line 99)


	
			
Variable Summary
Method Summary
 phpDocumentor_setup phpDocumentor_setup ()
 void checkIgnoreTag ( $tagname, [ $inline = false])
 void createDocs ([ $title = false])
 void parseHiddenFiles ([ $flag = true])
 void parseIni ()
 void readConfigFile (string $file)
 void setDirectoriesToParse ( $dirs)
 void setFilesToParse ( $files)
 void setIgnore ( $ig)
 void setJavadocDesc ()
 void setMemoryLimit ()
 void setPackageOutput ( $po)
 void setParsePrivate ([ $flag = true])
 void setQuietMode ([ $flag = true])
 void setTargetDir ( $target)
 void setTemplateBase ( $dir)
 void setTitle ( $ti)
 void setUndocumentedElementWarnings ([ $flag = true])
Variables
string $dirs = '' (line 132)

contents of --directory commandline

string $files = '' (line 126)

contents of --filename commandline

boolean $hidden = false (line 138)

contents of --hidden commandline

boolean $ignoresymlinks = false (line 154)

contents of --ignoresymlinks commandline

string $ignore_files = array() (line 149)

contents of --ignore commandline

string $packages = false (line 120)

Packages to create documentation for

Parser|phpDocumentorTParser $parse (line 105)

The main parser

phpDocumentor_IntermediateParser $render = false (line 115)

Used to organize output from the Parser before Conversion

Io $setup (line 110)

Used to parse command-line options

Methods
Constructor phpDocumentor_setup (line 161)

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

phpDocumentorTParser if version is 4.3.0+

phpDocumentor_setup phpDocumentor_setup ()
checkIgnoreTag (line 406)
void checkIgnoreTag ( $tagname, [ $inline = false])
  • $tagname
  • $inline
createDocs (line 539)
void createDocs ([ $title = false])
  • $title
parseHiddenFiles (line 522)
void parseHiddenFiles ([ $flag = true])
  • $flag
parseIni (line 780)

Parse configuration file phpDocumentor.ini

void parseIni ()
readCommandLineSettings (line 268)

Get phpDocumentor settings from command-line or web interface

void readCommandLineSettings ()
readConfigFile (line 234)

Get phpDocumentor settings from a user configuration file

void readConfigFile (string $file)
  • string $file: user configuration file
setDirectoriesToParse (line 517)
void setDirectoriesToParse ( $dirs)
  • $dirs
setFilesToParse (line 512)
void setFilesToParse ( $files)
  • $files
setIgnore (line 527)
void setIgnore ( $ig)
  • $ig
setJavadocDesc (line 471)
void setJavadocDesc ()
setMemoryLimit (line 419)

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"
void setMemoryLimit ()
setPackageOutput (line 501)
void setPackageOutput ( $po)
  • $po
setParsePrivate (line 476)
void setParsePrivate ([ $flag = true])
  • $flag
setQuietMode (line 481)
void setQuietMode ([ $flag = true])
  • $flag
setTargetDir (line 491)
void setTargetDir ( $target)
  • $target
setTemplateBase (line 496)
void setTemplateBase ( $dir)
  • $dir
setTitle (line 507)
void setTitle ( $ti)
  • $ti
setUndocumentedElementWarnings (line 486)
void setUndocumentedElementWarnings ([ $flag = true])
  • $flag

Documentation generated on Mon, 05 Dec 2011 21:40:21 -0600 by phpDocumentor 1.4.4