PHP Class TheSeer\phpDox\Application

See link: http://phpDox.de

Author: Arne Blankerts ([email protected])

ファイルを表示 Open project: theseer/phpdox

Public Methods

Method	Description
__construct ( Factory $factory, TheSeer\phpDox\ProgressLogger $logger )	Constructor of PHPDox Application
runBootstrap ( TheSeer\phpDox\FileInfoCollection $requires ) : Bootstrap	Run Bootstrap code for given list of bootstrap files
runCollector ( CollectorConfig $config ) : void	Run collection process on given directory tree
runConfigChangeDetection ( TheSeer\phpDox\FileInfo $workDirectory, TheSeer\phpDox\FileInfo $configFile )
runGenerator ( GeneratorConfig $config ) : void	Run Documentation generation process

Method Details

__construct() public method

Constructor of PHPDox Application

public __construct ( Factory $factory, TheSeer\phpDox\ProgressLogger $logger )
$factory	Factory	Factory instance
$logger	TheSeer\phpDox\ProgressLogger	Instance of the SilentProgressLogger class

runBootstrap() public method

Run Bootstrap code for given list of bootstrap files

public runBootstrap ( TheSeer\phpDox\FileInfoCollection $requires ) : Bootstrap
$requires	TheSeer\phpDox\FileInfoCollection
return	Bootstrap

runCollector() public method

Run collection process on given directory tree

public runCollector ( CollectorConfig $config ) : void
$config	CollectorConfig	Configuration options
return	void

runConfigChangeDetection() public method

public runConfigChangeDetection ( TheSeer\phpDox\FileInfo $workDirectory, TheSeer\phpDox\FileInfo $configFile )
$workDirectory	TheSeer\phpDox\FileInfo
$configFile	TheSeer\phpDox\FileInfo

runGenerator() public method

Run Documentation generation process

public runGenerator ( GeneratorConfig $config ) : void
$config	GeneratorConfig
return	void