Class phpDocumentor_setup

(line 99)

Description


Located in File: /phpDocumentor/Setup.inc.php



Class Variables

Summary:
string $dirs
string $files
boolean $hidden
boolean $ignoresymlinks
string $ignore_files
string $packages

$dirs = '' (line 132)

Data type : string

contents of --directory commandline

$files = '' (line 126)

Data type : string

contents of --filename commandline

$hidden = false (line 138)

Data type : boolean

contents of --hidden commandline

$ignoresymlinks = false (line 154)

Data type : boolean

contents of --ignoresymlinks commandline

$ignore_files = array() (line 149)

Data type : string

contents of --ignore commandline

$packages = false (line 120)

Data type : string

Packages to create documentation for

$parse (line 105)

Data type : Parser|phpDocumentorTParser

The main parser

$render = false (line 115)

Data type : phpDocumentor_IntermediateParser

Used to organize output from the Parser before Conversion

$setup (line 110)

Data type : Io

Used to parse command-line options

Class Constants

Summary:

Method Detail

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

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+

Info

Method checkIgnoreTag (line 406)

void checkIgnoreTag( $tagname, [ $inline = false])

Parameters

  • $tagname:
  • $inline:

Info

Method createDocs (line 539)

void createDocs( [ $title = false])

Parameters

  • $title:

Info

Method parseHiddenFiles (line 522)

void parseHiddenFiles( [ $flag = true])

Parameters

  • $flag:

Info

Method parseIni (line 780)

void parseIni( )

Parse configuration file phpDocumentor.ini

Info

Method readCommandLineSettings (line 268)

void readCommandLineSettings( )

Get phpDocumentor settings from command-line or web interface

Info

Method readConfigFile (line 234)

void readConfigFile( string $file)

Get phpDocumentor settings from a user configuration file

Parameters

  • string $file: user configuration file

Info

Method setDirectoriesToParse (line 517)

void setDirectoriesToParse( $dirs)

Parameters

  • $dirs:

Info

Method setFilesToParse (line 512)

void setFilesToParse( $files)

Parameters

  • $files:

Info

Method setIgnore (line 527)

void setIgnore( $ig)

Parameters

  • $ig:

Info

Method setJavadocDesc (line 471)

void setJavadocDesc( )

Info

Method setMemoryLimit (line 419)

void setMemoryLimit( )

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

Info

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

Method setPackageOutput (line 501)

void setPackageOutput( $po)

Parameters

  • $po:

Info

Method setParsePrivate (line 476)

void setParsePrivate( [ $flag = true])

Parameters

  • $flag:

Info

Method setQuietMode (line 481)

void setQuietMode( [ $flag = true])

Parameters

  • $flag:

Info

Method setTargetDir (line 491)

void setTargetDir( $target)

Parameters

  • $target:

Info

Method setTemplateBase (line 496)

void setTemplateBase( $dir)

Parameters

  • $dir:

Info

Method setTitle (line 507)

void setTitle( $ti)

Parameters

  • $ti:

Info

Method setUndocumentedElementWarnings (line 486)

void setUndocumentedElementWarnings( [ $flag = true])

Parameters

  • $flag:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


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