phpDocumentor

RunCommand extends Command
in package

Parse and transform the given directory (-d|-f) to the given location (-t).

phpDocumentor creates documentation from PHP source files. The simplest way to use it is:

$ phpdoc run -d <directory to parse> -t <output directory>

This will parse every file ending with .php, .php3 and .phtml in and then output a HTML site containing easily readable documentation in .

phpDocumentor will try to look for a phpdoc.dist.xml or phpdoc.xml file in your current working directory and use that to override the default settings if present. In the configuration file can you specify the same settings (and more) as the command line provides.

Table of Contents

Properties

$pipeline  : PipelineInterface
$progressBar  : ProgressBar|null
$projectDescriptorBuilder  : ProjectDescriptorBuilder
$transformerProgressBar  : ProgressBar|null

Methods

__construct()  : mixed
configure()  : void
Initializes this command and sets the name, description, options and arguments.
execute()  : int
Executes the business logic involved with this command.
durationInText()  : string
observeProgressToShowProgressBars()  : void

Properties

$pipeline read-only

private PipelineInterface $pipeline

$progressBar

private ProgressBar|null $progressBar = null

$transformerProgressBar

private ProgressBar|null $transformerProgressBar = null

Methods

configure()

Initializes this command and sets the name, description, options and arguments.

protected configure() : void

execute()

Executes the business logic involved with this command.

protected execute(InputInterface $input, OutputInterface $output) : int
Parameters
$input : InputInterface
$output : OutputInterface
Return values
int

durationInText()

private durationInText(StopwatchEvent $event) : string
Parameters
$event : StopwatchEvent
Return values
string

observeProgressToShowProgressBars()

private observeProgressToShowProgressBars(OutputInterface $output) : void
Parameters
$output : OutputInterface 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results