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

Class: phpDocumentor_setup

Source Location: /phpDocumentor/Setup.inc.php

Class Overview




Variables

Methods



Class Details

[line 99]


[ Top ]


Class Variables

$dirs =  ''

[line 132]

contents of --directory commandline



Tags:

tutorial:  -d, --directory

Type:   string


[ Top ]

$files =  ''

[line 126]

contents of --filename commandline



Tags:

tutorial:  -f, --filename

Type:   string


[ Top ]

$hidden =  false

[line 138]

contents of --hidden commandline



Tags:

tutorial:  -dh, --hidden

Type:   boolean


[ Top ]

$ignoresymlinks =  false

[line 154]

contents of --ignoresymlinks commandline


Type:   boolean


[ Top ]

$ignore_files = array()

[line 149]

contents of --ignore commandline



Tags:

tutorial:  -i, --ignore

Type:   string


[ Top ]

$packages =  false

[line 120]

Packages to create documentation for


Type:   string


[ Top ]

$parse =

[line 105]

The main parser




[ Top ]

$render =  false

[line 115]

Used to organize output from the Parser before Conversion




[ Top ]

$setup =

[line 110]

Used to parse command-line options


Type:   Io


[ Top ]



Class 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+




Tags:



[ Top ]

method checkIgnoreTag [line 406]

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



Parameters:

   $tagname  
   $inline  

[ Top ]

method createDocs [line 539]

void createDocs( [ $title = false])



Parameters:

   $title  

[ Top ]

method parseHiddenFiles [line 522]

void parseHiddenFiles( [ $flag = true])



Parameters:

   $flag  

[ Top ]

method parseIni [line 780]

void parseIni( )

Parse configuration file phpDocumentor.ini



Tags:



[ Top ]

method readCommandLineSettings [line 268]

void readCommandLineSettings( )

Get phpDocumentor settings from command-line or web interface



[ Top ]

method readConfigFile [line 234]

void readConfigFile( string $file)

Get phpDocumentor settings from a user configuration file



Parameters:

string   $file   user configuration file

[ Top ]

method setDirectoriesToParse [line 517]

void setDirectoriesToParse( $dirs)



Parameters:

   $dirs  

[ Top ]

method setFilesToParse [line 512]

void setFilesToParse( $files)



Parameters:

   $files  

[ Top ]

method setIgnore [line 527]

void setIgnore( $ig)



Parameters:

   $ig  

[ Top ]

method setJavadocDesc [line 471]

void setJavadocDesc( )



[ Top ]

method setMemoryLimit [line 419]

void setMemoryLimit( )

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"


[ Top ]

method setPackageOutput [line 501]

void setPackageOutput( $po)



Parameters:

   $po  

[ Top ]

method setParsePrivate [line 476]

void setParsePrivate( [ $flag = true])



Parameters:

   $flag  

[ Top ]

method setQuietMode [line 481]

void setQuietMode( [ $flag = true])



Parameters:

   $flag  

[ Top ]

method setTargetDir [line 491]

void setTargetDir( $target)



Parameters:

   $target  

[ Top ]

method setTemplateBase [line 496]

void setTemplateBase( $dir)



Parameters:

   $dir  

[ Top ]

method setTitle [line 507]

void setTitle( $ti)



Parameters:

   $ti  

[ Top ]

method setUndocumentedElementWarnings [line 486]

void setUndocumentedElementWarnings( [ $flag = true])



Parameters:

   $flag  

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:15:00 -0600 by phpDocumentor 1.4.4