Class: phpDocumentor_setup

Source Location: /phpDocumentor/Setup.inc.php

Class Overview [line 99]


Author(s):

Version:

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

[ Top ]


Class Variables

$dirs =  ''

[line 132]

contents of --directory commandline

Tags:

Type: string

Overrides:

[ Top ]

$files =  ''

[line 126]

contents of --filename commandline

Tags:

Type: string

Overrides:

[ Top ]

$hidden =  false

[line 138]

contents of --hidden commandline

Tags:

Type: boolean

Overrides:

[ Top ]

$ignoresymlinks =  false

[line 154]

contents of --ignoresymlinks commandline

Type: boolean

Overrides:

[ Top ]

$ignore_files = array()

[line 149]

contents of --ignore commandline

Tags:

Type: string

Overrides:

[ Top ]

$packages =  false

[line 120]

Packages to create documentation for

Type: string

Overrides:

[ Top ]

$parse

[line 105]

The main parser

Type: Parser|phpDocumentorTParser

Overrides:

[ Top ]

$render =  false

[line 115]

Used to organize output from the Parser before Conversion

Type: phpDocumentor_IntermediateParser

Overrides:

[ Top ]

$setup

[line 110]

Used to parse command-line options

Type: Io

Overrides:

[ Top ]


Class Methods

phpDocumentor_setup

phpDocumentor_setup phpDocumentor_setup( )

[line 161]

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

phpDocumentorTParser if version is 4.3.0+

Tags:

Parameters:

[ Top ]

checkIgnoreTag

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

[line 406]

Parameters:

  • $tagname -
  • $inline -

[ Top ]

createDocs

void createDocs( [ $title = false])

[line 539]

Parameters:

  • $title -

[ Top ]

parseHiddenFiles

void parseHiddenFiles( [ $flag = true])

[line 522]

Parameters:

  • $flag -

[ Top ]

parseIni

void parseIni( )

[line 780]

Parse configuration file phpDocumentor.ini

Tags:

Parameters:

[ Top ]

readCommandLineSettings

void readCommandLineSettings( )

[line 268]

Get phpDocumentor settings from command-line or web interface

Parameters:

[ Top ]

readConfigFile

void readConfigFile( string $file)

[line 234]

Get phpDocumentor settings from a user configuration file

Parameters:

  • string $file - user configuration file

[ Top ]

setDirectoriesToParse

void setDirectoriesToParse( $dirs)

[line 517]

Parameters:

  • $dirs -

[ Top ]

setFilesToParse

void setFilesToParse( $files)

[line 512]

Parameters:

  • $files -

[ Top ]

setIgnore

void setIgnore( $ig)

[line 527]

Parameters:

  • $ig -

[ Top ]

setJavadocDesc

void setJavadocDesc( )

[line 471]

Parameters:

[ Top ]

setMemoryLimit

void setMemoryLimit( )

[line 419]

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

Tags:

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

Parameters:

[ Top ]

setPackageOutput

void setPackageOutput( $po)

[line 501]

Parameters:

  • $po -

[ Top ]

setParsePrivate

void setParsePrivate( [ $flag = true])

[line 476]

Parameters:

  • $flag -

[ Top ]

setQuietMode

void setQuietMode( [ $flag = true])

[line 481]

Parameters:

  • $flag -

[ Top ]

setTargetDir

void setTargetDir( $target)

[line 491]

Parameters:

  • $target -

[ Top ]

setTemplateBase

void setTemplateBase( $dir)

[line 496]

Parameters:

  • $dir -

[ Top ]

setTitle

void setTitle( $ti)

[line 507]

Parameters:

  • $ti -

[ Top ]

setUndocumentedElementWarnings

void setUndocumentedElementWarnings( [ $flag = true])

[line 486]

Parameters:

  • $flag -

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:48 -0600 by phpDocumentor 1.4.4