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

Class: phpDocumentor_setup

Source Location: /phpDocumentor/Setup.inc.php

Class Overview




Variables

Methods



Class Details

[line 100]


[ Top ]


Class Variables

$dirs =  ''

[line 133]

contents of --directory commandline



Tags:

tutorial:  -d, --directory

Type:  string


[ Top ]

$files =  ''

[line 127]

contents of --filename commandline



Tags:

tutorial:  -f, --filename

Type:  string


[ Top ]

$hidden =  false

[line 139]

contents of --hidden commandline



Tags:

tutorial:  -dh, --hidden

Type:  boolean


[ Top ]

$ignoresymlinks =  false

[line 155]

contents of --ignoresymlinks commandline


Type:  boolean


[ Top ]

$ignore_files = array()

[line 150]

contents of --ignore commandline



Tags:

tutorial:  -i, --ignore

Type:  string


[ Top ]

$packages =  false

[line 121]

Packages to create documentation for


Type:  string


[ Top ]

$parse =

[line 106]

The main parser




[ Top ]

$render =  false

[line 116]

Used to organize output from the Parser before Conversion




[ Top ]

$setup =

[line 111]

Used to parse command-line options


Type:  Io


[ Top ]



Class Methods


constructor phpDocumentor_setup [line 162]

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

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



Parameters:

  $tagname 
  $inline 

[ Top ]

method createDocs [line 537]

void createDocs( [ $title = false])



Parameters:

  $title 

[ Top ]

method parseHiddenFiles [line 520]

void parseHiddenFiles( [ $flag = true])



Parameters:

  $flag 

[ Top ]

method parseIni [line 778]

void parseIni( )

Parse configuration file phpDocumentor.ini



Tags:



[ Top ]

method readCommandLineSettings [line 267]

void readCommandLineSettings( )

Get phpDocumentor settings from command-line or web interface



[ Top ]

method readConfigFile [line 233]

void readConfigFile( string $file)

Get phpDocumentor settings from a user configuration file



Parameters:

string  $file  user configuration file

[ Top ]

method setDirectoriesToParse [line 515]

void setDirectoriesToParse( $dirs)



Parameters:

  $dirs 

[ Top ]

method setFilesToParse [line 510]

void setFilesToParse( $files)



Parameters:

  $files 

[ Top ]

method setIgnore [line 525]

void setIgnore( $ig)



Parameters:

  $ig 

[ Top ]

method setJavadocDesc [line 469]

void setJavadocDesc( )



[ Top ]

method setMemoryLimit [line 417]

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

void setPackageOutput( $po)



Parameters:

  $po 

[ Top ]

method setParsePrivate [line 474]

void setParsePrivate( [ $flag = true])



Parameters:

  $flag 

[ Top ]

method setQuietMode [line 479]

void setQuietMode( [ $flag = true])



Parameters:

  $flag 

[ Top ]

method setTargetDir [line 489]

void setTargetDir( $target)



Parameters:

  $target 

[ Top ]

method setTemplateBase [line 494]

void setTemplateBase( $dir)



Parameters:

  $dir 

[ Top ]

method setTitle [line 505]

void setTitle( $ti)



Parameters:

  $ti 

[ Top ]

method setUndocumentedElementWarnings [line 484]

void setUndocumentedElementWarnings( [ $flag = true])



Parameters:

  $flag 

[ Top ]

    Поддержать сайт на родительском проекте КГБ