DocsCommand

Handles the generation of API documentation for the project.

This class MUST NOT be extended and SHALL utilize phpDocumentor to accomplish its task.

---

• Full name: \FastForward\DevTools\Console\Command\DocsCommand
• Parent class: BaseCommand
• This class is marked as final and can't be subclassed
• This class is a Final class

Methods

__construct

Creates a new DocsCommand instance.

public __construct(\FastForward\DevTools\Process\ProcessBuilderInterface $processBuilder, \FastForward\DevTools\Process\ProcessQueueInterface $processQueue, \Twig\Environment $renderer, \FastForward\DevTools\Filesystem\FilesystemInterface $filesystem, \FastForward\DevTools\Composer\Json\ComposerJsonInterface $composer): mixed

Parameters:

Parameter	Type	Description
$processBuilder	\FastForward\DevTools\Process\ProcessBuilderInterface	the process builder for executing phpDocumentor
$processQueue	\FastForward\DevTools\Process\ProcessQueueInterface	the process queue for managing execution
$renderer	\Twig\Environment
$filesystem	\FastForward\DevTools\Filesystem\FilesystemInterface	the filesystem for handling file operations
$composer	\FastForward\DevTools\Composer\Json\ComposerJsonInterface	the composer.json handler for accessing project metadata

---

configure

Configures the command instance.

protected configure(): void

The method MUST set up the name and description. It MAY accept an optional --target option pointing to an alternative configuration target path.

---

execute

Executes the generation of the documentation files.

protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): int

This method MUST compile arguments based on PSR-4 namespaces to feed into phpDocumentor. It SHOULD provide feedback on generation progress, and SHALL return self::SUCCESS on success.

Parameters:

Parameter	Type	Description
$input	\Symfony\Component\Console\Input\InputInterface	the input details for the command
$output	\Symfony\Component\Console\Output\OutputInterface	the output mechanism for logging

Return Value:

the final execution status code

---