PHP Класс TheSeer\phpDox\Application

Автор: Arne Blankerts ([email protected])
Показать файл Открыть проект

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

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() публичный Метод

Run Bootstrap code for given list of bootstrap files
public runBootstrap ( TheSeer\phpDox\FileInfoCollection $requires ) : Bootstrap
$requires TheSeer\phpDox\FileInfoCollection
Результат Bootstrap

runCollector() публичный Метод

Run collection process on given directory tree
public runCollector ( CollectorConfig $config ) : void
$config CollectorConfig Configuration options
Результат void

runConfigChangeDetection() публичный Метод

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

runGenerator() публичный Метод

Run Documentation generation process
public runGenerator ( GeneratorConfig $config ) : void
$config GeneratorConfig
Результат void