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

Class: phpDocumentor_setup

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Setup.inc.php

Class Overview




Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 101]


[ Top ]


Class Variables

$dirs =  ''

[line 134]

contents of --directory commandline

Type:   string


[ Top ]

$files =  ''

[line 128]

contents of --filename commandline

Type:   string


[ Top ]

$hidden =  false

[line 140]

contents of --hidden commandline

Type:   boolean


[ Top ]

$ignoresymlinks =  false

[line 156]

contents of --ignoresymlinks commandline

Type:   boolean


[ Top ]

$ignore_files = array()

[line 151]

contents of --ignore commandline

Type:   string


[ Top ]

$packages =  false

[line 122]

Packages to create documentation for

Type:   string


[ Top ]

$parse =

[line 107]

The main parser



[ Top ]

$render =  false

[line 117]

Used to organize output from the Parser before Conversion



[ Top ]

$setup =

[line 112]

Used to parse command-line options

Type:   Io


[ Top ]



Method Detail

phpDocumentor_setup (Constructor)   [line 163]

phpDocumentor_setup phpDocumentor_setup( )

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

phpDocumentorTParser if version is 4.3.0+


[ Top ]

checkIgnoreTag   [line 410]

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


Parameters:

   $tagname     
   $inline     

[ Top ]

createDocs   [line 543]

void createDocs( [ $title = false])


Parameters:

   $title     

[ Top ]

parseHiddenFiles   [line 526]

void parseHiddenFiles( [ $flag = true])


Parameters:

   $flag     

[ Top ]

parseIni   [line 784]

void parseIni( )

Parse configuration file phpDocumentor.ini

[ Top ]

readCommandLineSettings   [line 270]

void readCommandLineSettings( )

Get phpDocumentor settings from command-line or web interface

[ Top ]

readConfigFile   [line 236]

void readConfigFile( string $file)

Get phpDocumentor settings from a user configuration file

Parameters:

string   $file     user configuration file

[ Top ]

setDirectoriesToParse   [line 521]

void setDirectoriesToParse( $dirs)


Parameters:

   $dirs     

[ Top ]

setFilesToParse   [line 516]

void setFilesToParse( $files)


Parameters:

   $files     

[ Top ]

setIgnore   [line 531]

void setIgnore( $ig)


Parameters:

   $ig     

[ Top ]

setJavadocDesc   [line 475]

void setJavadocDesc( )


[ Top ]

setMemoryLimit   [line 423]

void setMemoryLimit( )

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"

[ Top ]

setPackageOutput   [line 505]

void setPackageOutput( $po)


Parameters:

   $po     

[ Top ]

setParsePrivate   [line 480]

void setParsePrivate( [ $flag = true])


Parameters:

   $flag     

[ Top ]

setQuietMode   [line 485]

void setQuietMode( [ $flag = true])


Parameters:

   $flag     

[ Top ]

setTargetDir   [line 495]

void setTargetDir( $target)


Parameters:

   $target     

[ Top ]

setTemplateBase   [line 500]

void setTemplateBase( $dir)


Parameters:

   $dir     

[ Top ]

setTitle   [line 511]

void setTitle( $ti)


Parameters:

   $ti     

[ Top ]

setUndocumentedElementWarnings   [line 490]

void setUndocumentedElementWarnings( [ $flag = true])


Parameters:

   $flag     

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:03:04 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.