RunCommand
in package
extends Command
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 <directory to parse> 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.
Properties
$projectDescriptorBuilder Line 59
private$projectDescriptorBuilder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder
$pipeline Line 62
private$pipeline : \League\Pipeline\PipelineInterface
$progressBar Line 65
private$progressBar : \Symfony\Component\Console\Helper\ProgressBar
$transformerProgressBar Line 68
private$transformerProgressBar : \Symfony\Component\Console\Helper\ProgressBar
Methods
__construct() Line 70
public__construct(ProjectDescriptorBuilder $projectDescriptorBuilder, PipelineInterface $pipeline) : mixed
Parameters
Returns
mixed —
configure() Line 84
Initializes this command and sets the name, description, options and arguments.
protectedconfigure() : void
execute() Line 264
Executes the business logic involved with this command.
protectedexecute(InputInterface $input, OutputInterface $output) : int