@@ -150,7 +187,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParame
```php
@@ -178,7 +215,7 @@ public function getCacheDir(): string|null;
```php
@@ -199,7 +236,7 @@ public function getDocGenLibDir(): string;
```php
@@ -227,7 +264,7 @@ public function getGitClientPath(): string;
```php
@@ -261,7 +298,7 @@ public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\L
```php
@@ -289,7 +326,7 @@ public function getOutputDir(): string;
```php
@@ -317,7 +354,7 @@ public function getOutputDirBaseUrl(): string;
```php
@@ -351,7 +388,7 @@ public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProc
```php
@@ -385,7 +422,7 @@ public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```php
@@ -413,7 +450,7 @@ public function getProjectRoot(): string;
```php
@@ -447,7 +484,7 @@ public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\Sou
```php
@@ -475,7 +512,7 @@ public function getTemplatesDir(): string;
```php
@@ -509,7 +546,7 @@ public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
```php
@@ -543,7 +580,7 @@ public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\Cu
```php
@@ -571,7 +608,7 @@ public function getWorkingDir(): string;
```php
@@ -599,7 +636,7 @@ public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```php
diff --git a/docs/tech/1.configuration/readme.md b/docs/tech/1.configuration/readme.md
index c6f0b40e..766e6d25 100644
--- a/docs/tech/1.configuration/readme.md
+++ b/docs/tech/1.configuration/readme.md
@@ -209,9 +209,15 @@ The inheritance algorithm is as follows: scalar types can be overwritten by each
List of plugins |
+
+ | additional_console_commands |
+ array<Command> |
+ NULL |
+ Additional console commands |
+
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with
Bumble Documentation Generator
- | $classEntityCollections |
+ $classEntityCollections (variadic) |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection |
The collection of entities for which the class map will be generated |
diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md
index 0755e794..bdcec51d 100644
--- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md
+++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_2.md
@@ -211,13 +211,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+ \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+ \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
diff --git a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md
index b4ed9a18..781ce3b7 100644
--- a/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md
+++ b/docs/tech/3.renderer/classes/GetDocumentedEntityUrl_3.md
@@ -211,13 +211,13 @@ public function __invoke(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+ \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
\DI\NotFoundException
- \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
+ \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
diff --git a/docs/tech/3.renderer/readme.md b/docs/tech/3.renderer/readme.md
index d982caaf..daea1feb 100644
--- a/docs/tech/3.renderer/readme.md
+++ b/docs/tech/3.renderer/readme.md
@@ -60,4 +60,4 @@ This process is presented in the form of a diagram below.
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/templates.md b/docs/tech/3.renderer/templates.md
index 285e49ad..5ffaa888 100644
--- a/docs/tech/3.renderer/templates.md
+++ b/docs/tech/3.renderer/templates.md
@@ -101,4 +101,4 @@ Result after starting the documentation generation process:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/templatesDynamicBlocks.md b/docs/tech/3.renderer/templatesDynamicBlocks.md
index 329a86bf..8a4f475b 100644
--- a/docs/tech/3.renderer/templatesDynamicBlocks.md
+++ b/docs/tech/3.renderer/templatesDynamicBlocks.md
@@ -26,4 +26,4 @@ You can use the built-in functions and filters or add your own, so you can imple
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/templatesLinking.md b/docs/tech/3.renderer/templatesLinking.md
index 3034b9be..360b9e7c 100644
--- a/docs/tech/3.renderer/templatesLinking.md
+++ b/docs/tech/3.renderer/templatesLinking.md
@@ -27,4 +27,4 @@ You can also implement your own functions for relinking if necessary.
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/templatesVariables.md b/docs/tech/3.renderer/templatesVariables.md
index daaae8e5..31c9ec2f 100644
--- a/docs/tech/3.renderer/templatesVariables.md
+++ b/docs/tech/3.renderer/templatesVariables.md
@@ -11,4 +11,4 @@ There are several variables available in each processed template.
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Thu Sep 28 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/twigCustomFilters.md b/docs/tech/3.renderer/twigCustomFilters.md
index c6a5e7d9..e573dd50 100644
--- a/docs/tech/3.renderer/twigCustomFilters.md
+++ b/docs/tech/3.renderer/twigCustomFilters.md
@@ -263,4 +263,4 @@ Here is a list of filters available by default:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/twigCustomFunctions.md b/docs/tech/3.renderer/twigCustomFunctions.md
index 09663778..29b1c0d3 100644
--- a/docs/tech/3.renderer/twigCustomFunctions.md
+++ b/docs/tech/3.renderer/twigCustomFunctions.md
@@ -385,4 +385,4 @@ Here is a list of functions available by default:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Thu Sep 28 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/4.pluginSystem/readme.md b/docs/tech/4.pluginSystem/readme.md
index 2ba21d3d..94e263dc 100644
--- a/docs/tech/4.pluginSystem/readme.md
+++ b/docs/tech/4.pluginSystem/readme.md
@@ -192,4 +192,4 @@ plugins:
-
Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Sun Sep 10 2023
Made with
Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Sep 2 21:01:47 2023 +0300
Page content update date: Wed Sep 27 2023
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/classes/AddMissingDocBlocksCommand.md b/docs/tech/classes/AddMissingDocBlocksCommand.md
new file mode 100644
index 00000000..56d9f65f
--- /dev/null
+++ b/docs/tech/classes/AddMissingDocBlocksCommand.md
@@ -0,0 +1,1384 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Console\Command;
+
+final class AddMissingDocBlocksCommand extends \BumbleDocGen\Console\Command\BaseCommand
+```
+
+Base class for all commands.
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ addArgument
+ - Adds an argument.
+-
+ addOption
+ - Adds an option.
+-
+ addUsage
+ - Add a command usage example, it'll be prefixed with the command name.
+-
+ complete
+ - Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+-
+ getAliases
+ - Returns the aliases for the command.
+-
+ getApplication
+ - Gets the application instance for this command.
+-
+ getDefaultDescription
+
+-
+ getDefaultName
+
+-
+ getDefinition
+ - Gets the InputDefinition attached to this Command.
+-
+ getDescription
+ - Returns the description for the command.
+-
+ getHelp
+ - Returns the help for the command.
+-
+ getHelper
+ - Gets a helper instance by name.
+-
+ getHelperSet
+ - Gets the helper set.
+-
+ getName
+ - Returns the command name.
+-
+ getNativeDefinition
+ - Gets the InputDefinition to be used to create representations of this Command.
+-
+ getProcessedHelp
+ - Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
+-
+ getSynopsis
+ - Returns the synopsis for the command.
+-
+ getUsages
+ - Returns alternative usages of the command.
+-
+ ignoreValidationErrors
+ - Ignores validation errors.
+-
+ isEnabled
+ - Checks whether the command is enabled or not in the current environment.
+-
+ isHidden
+
+-
+ mergeApplicationDefinition
+ - Merges the application definition with the command definition.
+-
+ run
+ - Runs the command.
+-
+ setAliases
+ - Sets the aliases for the command.
+-
+ setApplication
+
+-
+ setCode
+ - Sets the code to execute when running this command.
+-
+ setDefinition
+ - Sets an array of argument and option instances.
+-
+ setDescription
+ - Sets the description for the command.
+-
+ setHelp
+ - Sets the help for the command.
+-
+ setHelperSet
+
+-
+ setHidden
+
+-
+ setName
+ - Sets the name of the command.
+-
+ setProcessTitle
+ - Sets the process title of the command.
+
+
+
+Constants:
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Console\Command\BaseCommand
+
+public function __construct(string|null $name = NULL);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string | null |
+ The name of the command; passing null means it must be set in configure() |
+
+
+
+
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addArgument(string $name, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an argument.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $mode |
+ int | null |
+ The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (for InputArgument::OPTIONAL mode only) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addOption(string $name, string|array|null $shortcut = NULL, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an option.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $shortcut |
+ string | array | null |
+ The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts |
+
+
+ | $mode |
+ int | null |
+ The option mode: One of the InputOption::VALUE_* constants |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (must be null for InputOption::VALUE_NONE) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addUsage(string $usage): static;
+```
+
+
Add a command usage example, it'll be prefixed with the command name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $usage |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function complete(\Symfony\Component\Console\Completion\CompletionInput $input, \Symfony\Component\Console\Completion\CompletionSuggestions $suggestions): void;
+```
+
+
Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+
+
Parameters:
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getAliases(): array;
+```
+
+
Returns the aliases for the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getApplication(): \Symfony\Component\Console\Application|null;
+```
+
+
Gets the application instance for this command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Application |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultDescription(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultName(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition attached to this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDescription(): string;
+```
+
+
Returns the description for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelp(): string;
+```
+
+
Returns the help for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelper(string $name): mixed;
+```
+
+
Gets a helper instance by name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: mixed
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelperSet(): \Symfony\Component\Console\Helper\HelperSet|null;
+```
+
+
Gets the helper set.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Helper\HelperSet |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getName(): string|null;
+```
+
+
Returns the command name.
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getNativeDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition to be used to create representations of this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getProcessedHelp(): string;
+```
+
+
Returns the processed help for the command replacing the %command.name% and
+%command.full_name% patterns with the real values dynamically.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getSynopsis(bool $short = false): string;
+```
+
+
Returns the synopsis for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $short |
+ bool |
+ Whether to show the short version of the synopsis (with options folded) or not |
+
+
+
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getUsages(): array;
+```
+
+
Returns alternative usages of the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function ignoreValidationErrors(): mixed;
+```
+
+
Ignores validation errors.
+
+
Parameters: not specified
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isEnabled(): bool;
+```
+
+
Checks whether the command is enabled or not in the current environment.
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isHidden(): bool;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+- #
+ mergeApplicationDefinition
+ :warning: Is internal | source code
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function mergeApplicationDefinition(bool $mergeArgs = true): mixed;
+```
+
+
Merges the application definition with the command definition.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $mergeArgs |
+ bool |
+ Whether to merge or not the Application definition arguments to Command definition arguments |
+
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): int;
+```
+
+
Runs the command.
+
+
Parameters:
+
+
+
+
Return value: int
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setAliases(iterable $aliases): static;
+```
+
+
Sets the aliases for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $aliases |
+ iterable |
+ An array of aliases for the command |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setApplication(\Symfony\Component\Console\Application|null $application = NULL): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setCode(callable $code): static;
+```
+
+
Sets the code to execute when running this command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $code |
+ callable |
+ A callable(InputInterface $input, OutputInterface $output) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDefinition(array|\Symfony\Component\Console\Input\InputDefinition $definition): static;
+```
+
+
Sets an array of argument and option instances.
+
+
Parameters:
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDescription(string $description): static;
+```
+
+
Sets the description for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $description |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelp(string $help): static;
+```
+
+
Sets the help for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $help |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHidden(bool $hidden = true): static;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $hidden |
+ bool |
+ Whether or not the command should be hidden from the list of commands |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setName(string $name): static;
+```
+
+
Sets the name of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setProcessTitle(string $title): static;
+```
+
+
Sets the process title of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $title |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/AdditionalCommandCollection.md b/docs/tech/classes/AdditionalCommandCollection.md
new file mode 100644
index 00000000..7f4740ca
--- /dev/null
+++ b/docs/tech/classes/AdditionalCommandCollection.md
@@ -0,0 +1,159 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Console\Command;
+
+final class AdditionalCommandCollection implements \IteratorAggregate, \Traversable
+```
+
+
+
+
+
+
+
+
+
+Methods:
+
+
+-
+ add
+
+-
+ create
+
+-
+ getIterator
+ - Retrieve an external iterator
+
+
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+
+
+
+
+```php
+public function getIterator(): \Generator;
+```
+
+
Retrieve an external iterator
+
+
Parameters: not specified
+
+
Return value: \Generator
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/App.md b/docs/tech/classes/App.md
index 1cb8ecb9..a1700ae4 100644
--- a/docs/tech/classes/App.md
+++ b/docs/tech/classes/App.md
@@ -2,7 +2,7 @@
- App class:
+ App class:
@@ -107,7 +107,7 @@ class App extends \Symfony\Component\Console\Application implements \Symfony\Con
reset
-
+ - This method is used to reset an object to its initial state.
run
- Runs the current application.
@@ -156,7 +156,7 @@ class App extends \Symfony\Component\Console\Application implements \Symfony\Con
```php
@@ -999,7 +999,7 @@ public function renderThrowable(\Throwable $e, \Symfony\Component\Console\Output
public function reset(): mixed;
```
-
+This method is used to reset an object to its initial state.
Parameters: not specified
diff --git a/docs/tech/classes/BaseCommand.md b/docs/tech/classes/BaseCommand.md
new file mode 100644
index 00000000..144803b8
--- /dev/null
+++ b/docs/tech/classes/BaseCommand.md
@@ -0,0 +1,1382 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Console\Command;
+
+abstract class BaseCommand extends \Symfony\Component\Console\Command\Command
+```
+
+Base class for all commands.
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ addArgument
+ - Adds an argument.
+-
+ addOption
+ - Adds an option.
+-
+ addUsage
+ - Add a command usage example, it'll be prefixed with the command name.
+-
+ complete
+ - Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+-
+ getAliases
+ - Returns the aliases for the command.
+-
+ getApplication
+ - Gets the application instance for this command.
+-
+ getDefaultDescription
+
+-
+ getDefaultName
+
+-
+ getDefinition
+ - Gets the InputDefinition attached to this Command.
+-
+ getDescription
+ - Returns the description for the command.
+-
+ getHelp
+ - Returns the help for the command.
+-
+ getHelper
+ - Gets a helper instance by name.
+-
+ getHelperSet
+ - Gets the helper set.
+-
+ getName
+ - Returns the command name.
+-
+ getNativeDefinition
+ - Gets the InputDefinition to be used to create representations of this Command.
+-
+ getProcessedHelp
+ - Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
+-
+ getSynopsis
+ - Returns the synopsis for the command.
+-
+ getUsages
+ - Returns alternative usages of the command.
+-
+ ignoreValidationErrors
+ - Ignores validation errors.
+-
+ isEnabled
+ - Checks whether the command is enabled or not in the current environment.
+-
+ isHidden
+
+-
+ mergeApplicationDefinition
+ - Merges the application definition with the command definition.
+-
+ run
+ - Runs the command.
+-
+ setAliases
+ - Sets the aliases for the command.
+-
+ setApplication
+
+-
+ setCode
+ - Sets the code to execute when running this command.
+-
+ setDefinition
+ - Sets an array of argument and option instances.
+-
+ setDescription
+ - Sets the description for the command.
+-
+ setHelp
+ - Sets the help for the command.
+-
+ setHelperSet
+
+-
+ setHidden
+
+-
+ setName
+ - Sets the name of the command.
+-
+ setProcessTitle
+ - Sets the process title of the command.
+
+
+
+Constants:
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+public function __construct(string|null $name = NULL);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string | null |
+ The name of the command; passing null means it must be set in configure() |
+
+
+
+
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addArgument(string $name, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an argument.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $mode |
+ int | null |
+ The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (for InputArgument::OPTIONAL mode only) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addOption(string $name, string|array|null $shortcut = NULL, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an option.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $shortcut |
+ string | array | null |
+ The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts |
+
+
+ | $mode |
+ int | null |
+ The option mode: One of the InputOption::VALUE_* constants |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (must be null for InputOption::VALUE_NONE) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addUsage(string $usage): static;
+```
+
+
Add a command usage example, it'll be prefixed with the command name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $usage |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function complete(\Symfony\Component\Console\Completion\CompletionInput $input, \Symfony\Component\Console\Completion\CompletionSuggestions $suggestions): void;
+```
+
+
Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+
+
Parameters:
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getAliases(): array;
+```
+
+
Returns the aliases for the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getApplication(): \Symfony\Component\Console\Application|null;
+```
+
+
Gets the application instance for this command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Application |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultDescription(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultName(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition attached to this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDescription(): string;
+```
+
+
Returns the description for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelp(): string;
+```
+
+
Returns the help for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelper(string $name): mixed;
+```
+
+
Gets a helper instance by name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: mixed
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelperSet(): \Symfony\Component\Console\Helper\HelperSet|null;
+```
+
+
Gets the helper set.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Helper\HelperSet |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getName(): string|null;
+```
+
+
Returns the command name.
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getNativeDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition to be used to create representations of this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getProcessedHelp(): string;
+```
+
+
Returns the processed help for the command replacing the %command.name% and
+%command.full_name% patterns with the real values dynamically.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getSynopsis(bool $short = false): string;
+```
+
+
Returns the synopsis for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $short |
+ bool |
+ Whether to show the short version of the synopsis (with options folded) or not |
+
+
+
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getUsages(): array;
+```
+
+
Returns alternative usages of the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function ignoreValidationErrors(): mixed;
+```
+
+
Ignores validation errors.
+
+
Parameters: not specified
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isEnabled(): bool;
+```
+
+
Checks whether the command is enabled or not in the current environment.
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isHidden(): bool;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+- #
+ mergeApplicationDefinition
+ :warning: Is internal | source code
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function mergeApplicationDefinition(bool $mergeArgs = true): mixed;
+```
+
+
Merges the application definition with the command definition.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $mergeArgs |
+ bool |
+ Whether to merge or not the Application definition arguments to Command definition arguments |
+
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): int;
+```
+
+
Runs the command.
+
+
Parameters:
+
+
+
+
Return value: int
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setAliases(iterable $aliases): static;
+```
+
+
Sets the aliases for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $aliases |
+ iterable |
+ An array of aliases for the command |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setApplication(\Symfony\Component\Console\Application|null $application = NULL): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setCode(callable $code): static;
+```
+
+
Sets the code to execute when running this command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $code |
+ callable |
+ A callable(InputInterface $input, OutputInterface $output) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDefinition(array|\Symfony\Component\Console\Input\InputDefinition $definition): static;
+```
+
+
Sets an array of argument and option instances.
+
+
Parameters:
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDescription(string $description): static;
+```
+
+
Sets the description for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $description |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelp(string $help): static;
+```
+
+
Sets the help for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $help |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHidden(bool $hidden = true): static;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $hidden |
+ bool |
+ Whether or not the command should be hidden from the list of commands |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setName(string $name): static;
+```
+
+
Sets the name of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setProcessTitle(string $title): static;
+```
+
+
Sets the process title of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $title |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/ClassEntityCollection.md b/docs/tech/classes/ClassEntityCollection.md
index 10f912b6..4595b21b 100644
--- a/docs/tech/classes/ClassEntityCollection.md
+++ b/docs/tech/classes/ClassEntityCollection.md
@@ -131,7 +131,7 @@ final class ClassEntityCollection extends \BumbleDocGen\Core\Parser\Entity\Logga
```php
-public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Console\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Psr\Log\LoggerInterface $logger);
+public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory, \BumbleDocGen\LanguageHandler\Php\Renderer\EntityDocRenderer\EntityDocRendererHelper $docRendererHelper, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Psr\Log\LoggerInterface $logger);
```
@@ -184,7 +184,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
| $progressBarFactory |
- \BumbleDocGen\Core\Console\ProgressBarFactory |
+ \BumbleDocGen\Console\ProgressBar\ProgressBarFactory |
- |
diff --git a/docs/tech/classes/Configuration.md b/docs/tech/classes/Configuration.md
index df6c41ea..bfe8e1e4 100644
--- a/docs/tech/classes/Configuration.md
+++ b/docs/tech/classes/Configuration.md
@@ -2,7 +2,7 @@
@@ -33,6 +33,9 @@ final class Configuration
Methods:
+-
+ getAdditionalConsoleCommands
+
-
getCacheDir
@@ -88,7 +91,7 @@ final class Configuration
@@ -103,7 +106,7 @@ final class Configuration
```php
@@ -143,6 +146,40 @@ public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParame
+
+
+
@@ -150,7 +187,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParame
```php
@@ -178,7 +215,7 @@ public function getCacheDir(): string|null;
```php
@@ -199,7 +236,7 @@ public function getDocGenLibDir(): string;
```php
@@ -227,7 +264,7 @@ public function getGitClientPath(): string;
```php
@@ -261,7 +298,7 @@ public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\L
```php
@@ -289,7 +326,7 @@ public function getOutputDir(): string;
```php
@@ -317,7 +354,7 @@ public function getOutputDirBaseUrl(): string;
```php
@@ -351,7 +388,7 @@ public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProc
```php
@@ -385,7 +422,7 @@ public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
```php
@@ -413,7 +450,7 @@ public function getProjectRoot(): string;
```php
@@ -447,7 +484,7 @@ public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\Sou
```php
@@ -475,7 +512,7 @@ public function getTemplatesDir(): string;
```php
@@ -509,7 +546,7 @@ public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
```php
@@ -543,7 +580,7 @@ public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\Cu
```php
@@ -571,7 +608,7 @@ public function getWorkingDir(): string;
```php
@@ -599,7 +636,7 @@ public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
```php
diff --git a/docs/tech/classes/DocGeneratorFactory.md b/docs/tech/classes/DocGeneratorFactory.md
index 3d588452..bb0a0c29 100644
--- a/docs/tech/classes/DocGeneratorFactory.md
+++ b/docs/tech/classes/DocGeneratorFactory.md
@@ -2,7 +2,7 @@
@@ -36,9 +36,15 @@ final class DocGeneratorFactory
-
create
+
-
+ createConfiguration
+
-
setCustomConfigurationParameters
+
-
+ setCustomDiDefinitions
+
@@ -54,7 +60,7 @@ final class DocGeneratorFactory
```php
@@ -91,7 +97,7 @@ public function __construct(string $diConfig = '/src/di-config.php');
```php
@@ -122,6 +128,57 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen
Return value: \BumbleDocGen\DocGenerator
+
Throws:
+
+
+
+
+
+
+
+```php
+public function createConfiguration(string ...$configurationFiles): \BumbleDocGen\Core\Configuration\Configuration;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $configurationFiles (variadic) |
+ string |
+ - |
+
+
+
+
+
Return value: \BumbleDocGen\Core\Configuration\Configuration
+
+
Throws:
-
@@ -142,7 +199,7 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen
```php
@@ -173,6 +230,44 @@ public function setCustomConfigurationParameters(array $customConfigurationParam
Return value: void
+
+
+
+
+
+```php
+public function setCustomDiDefinitions(array $definitions): void;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $definitions |
+ array |
+ - |
+
+
+
+
+
Return value: void
+
+
diff --git a/docs/tech/classes/DrawClassMap.md b/docs/tech/classes/DrawClassMap.md
index 9722278f..ccf8be21 100644
--- a/docs/tech/classes/DrawClassMap.md
+++ b/docs/tech/classes/DrawClassMap.md
@@ -132,7 +132,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Twig\Function\GetDocumen
```php
-public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection $classEntityCollections): string;
+public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection ...$classEntityCollections): string;
```
@@ -149,7 +149,7 @@ public function __invoke(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEn
- | $classEntityCollections |
+ $classEntityCollections (variadic) |
\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntityCollection |
The collection of entities for which the class map will be generated |
diff --git a/docs/tech/classes/FillInReadmeMdTemplateCommand.md b/docs/tech/classes/FillInReadmeMdTemplateCommand.md
new file mode 100644
index 00000000..36445355
--- /dev/null
+++ b/docs/tech/classes/FillInReadmeMdTemplateCommand.md
@@ -0,0 +1,1384 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Console\Command;
+
+final class FillInReadmeMdTemplateCommand extends \BumbleDocGen\Console\Command\BaseCommand
+```
+
+Base class for all commands.
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ addArgument
+ - Adds an argument.
+-
+ addOption
+ - Adds an option.
+-
+ addUsage
+ - Add a command usage example, it'll be prefixed with the command name.
+-
+ complete
+ - Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+-
+ getAliases
+ - Returns the aliases for the command.
+-
+ getApplication
+ - Gets the application instance for this command.
+-
+ getDefaultDescription
+
+-
+ getDefaultName
+
+-
+ getDefinition
+ - Gets the InputDefinition attached to this Command.
+-
+ getDescription
+ - Returns the description for the command.
+-
+ getHelp
+ - Returns the help for the command.
+-
+ getHelper
+ - Gets a helper instance by name.
+-
+ getHelperSet
+ - Gets the helper set.
+-
+ getName
+ - Returns the command name.
+-
+ getNativeDefinition
+ - Gets the InputDefinition to be used to create representations of this Command.
+-
+ getProcessedHelp
+ - Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
+-
+ getSynopsis
+ - Returns the synopsis for the command.
+-
+ getUsages
+ - Returns alternative usages of the command.
+-
+ ignoreValidationErrors
+ - Ignores validation errors.
+-
+ isEnabled
+ - Checks whether the command is enabled or not in the current environment.
+-
+ isHidden
+
+-
+ mergeApplicationDefinition
+ - Merges the application definition with the command definition.
+-
+ run
+ - Runs the command.
+-
+ setAliases
+ - Sets the aliases for the command.
+-
+ setApplication
+
+-
+ setCode
+ - Sets the code to execute when running this command.
+-
+ setDefinition
+ - Sets an array of argument and option instances.
+-
+ setDescription
+ - Sets the description for the command.
+-
+ setHelp
+ - Sets the help for the command.
+-
+ setHelperSet
+
+-
+ setHidden
+
+-
+ setName
+ - Sets the name of the command.
+-
+ setProcessTitle
+ - Sets the process title of the command.
+
+
+
+Constants:
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Console\Command\BaseCommand
+
+public function __construct(string|null $name = NULL);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string | null |
+ The name of the command; passing null means it must be set in configure() |
+
+
+
+
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addArgument(string $name, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an argument.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $mode |
+ int | null |
+ The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (for InputArgument::OPTIONAL mode only) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addOption(string $name, string|array|null $shortcut = NULL, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an option.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $shortcut |
+ string | array | null |
+ The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts |
+
+
+ | $mode |
+ int | null |
+ The option mode: One of the InputOption::VALUE_* constants |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (must be null for InputOption::VALUE_NONE) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addUsage(string $usage): static;
+```
+
+
Add a command usage example, it'll be prefixed with the command name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $usage |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function complete(\Symfony\Component\Console\Completion\CompletionInput $input, \Symfony\Component\Console\Completion\CompletionSuggestions $suggestions): void;
+```
+
+
Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+
+
Parameters:
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getAliases(): array;
+```
+
+
Returns the aliases for the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getApplication(): \Symfony\Component\Console\Application|null;
+```
+
+
Gets the application instance for this command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Application |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultDescription(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultName(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition attached to this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDescription(): string;
+```
+
+
Returns the description for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelp(): string;
+```
+
+
Returns the help for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelper(string $name): mixed;
+```
+
+
Gets a helper instance by name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: mixed
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelperSet(): \Symfony\Component\Console\Helper\HelperSet|null;
+```
+
+
Gets the helper set.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Helper\HelperSet |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getName(): string|null;
+```
+
+
Returns the command name.
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getNativeDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition to be used to create representations of this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getProcessedHelp(): string;
+```
+
+
Returns the processed help for the command replacing the %command.name% and
+%command.full_name% patterns with the real values dynamically.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getSynopsis(bool $short = false): string;
+```
+
+
Returns the synopsis for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $short |
+ bool |
+ Whether to show the short version of the synopsis (with options folded) or not |
+
+
+
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getUsages(): array;
+```
+
+
Returns alternative usages of the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function ignoreValidationErrors(): mixed;
+```
+
+
Ignores validation errors.
+
+
Parameters: not specified
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isEnabled(): bool;
+```
+
+
Checks whether the command is enabled or not in the current environment.
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isHidden(): bool;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+- #
+ mergeApplicationDefinition
+ :warning: Is internal | source code
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function mergeApplicationDefinition(bool $mergeArgs = true): mixed;
+```
+
+
Merges the application definition with the command definition.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $mergeArgs |
+ bool |
+ Whether to merge or not the Application definition arguments to Command definition arguments |
+
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): int;
+```
+
+
Runs the command.
+
+
Parameters:
+
+
+
+
Return value: int
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setAliases(iterable $aliases): static;
+```
+
+
Sets the aliases for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $aliases |
+ iterable |
+ An array of aliases for the command |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setApplication(\Symfony\Component\Console\Application|null $application = NULL): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setCode(callable $code): static;
+```
+
+
Sets the code to execute when running this command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $code |
+ callable |
+ A callable(InputInterface $input, OutputInterface $output) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDefinition(array|\Symfony\Component\Console\Input\InputDefinition $definition): static;
+```
+
+
Sets an array of argument and option instances.
+
+
Parameters:
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDescription(string $description): static;
+```
+
+
Sets the description for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $description |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelp(string $help): static;
+```
+
+
Sets the help for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $help |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHidden(bool $hidden = true): static;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $hidden |
+ bool |
+ Whether or not the command should be hidden from the list of commands |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setName(string $name): static;
+```
+
+
Sets the name of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setProcessTitle(string $title): static;
+```
+
+
Sets the process title of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $title |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/GenerateCommand.md b/docs/tech/classes/GenerateCommand.md
index f456b883..3bc6dc05 100644
--- a/docs/tech/classes/GenerateCommand.md
+++ b/docs/tech/classes/GenerateCommand.md
@@ -2,7 +2,7 @@
@@ -12,7 +12,7 @@
```php
namespace BumbleDocGen\Console\Command;
-final class GenerateCommand extends \Symfony\Component\Console\Command\Command
+final class GenerateCommand extends \BumbleDocGen\Console\Command\BaseCommand
```
Base class for all commands.
@@ -162,11 +162,11 @@ final class GenerateCommand extends \Symfony\Component\Console\Command\Command
```php
-// Implemented in Symfony\Component\Console\Command\Command
+// Implemented in BumbleDocGen\Console\Command\BaseCommand
public function __construct(string|null $name = NULL);
```
diff --git a/docs/tech/classes/GenerateProjectTemplatesStructureCommand.md b/docs/tech/classes/GenerateProjectTemplatesStructureCommand.md
new file mode 100644
index 00000000..bfe6996b
--- /dev/null
+++ b/docs/tech/classes/GenerateProjectTemplatesStructureCommand.md
@@ -0,0 +1,1384 @@
+
+
+
+
+
+
+
+
+
+```php
+namespace BumbleDocGen\Console\Command;
+
+final class GenerateProjectTemplatesStructureCommand extends \BumbleDocGen\Console\Command\BaseCommand
+```
+
+Base class for all commands.
+
+
+
+
+
+
+Initialization methods:
+
+
+-
+ __construct
+
+
+
+Methods:
+
+
+-
+ addArgument
+ - Adds an argument.
+-
+ addOption
+ - Adds an option.
+-
+ addUsage
+ - Add a command usage example, it'll be prefixed with the command name.
+-
+ complete
+ - Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+-
+ getAliases
+ - Returns the aliases for the command.
+-
+ getApplication
+ - Gets the application instance for this command.
+-
+ getDefaultDescription
+
+-
+ getDefaultName
+
+-
+ getDefinition
+ - Gets the InputDefinition attached to this Command.
+-
+ getDescription
+ - Returns the description for the command.
+-
+ getHelp
+ - Returns the help for the command.
+-
+ getHelper
+ - Gets a helper instance by name.
+-
+ getHelperSet
+ - Gets the helper set.
+-
+ getName
+ - Returns the command name.
+-
+ getNativeDefinition
+ - Gets the InputDefinition to be used to create representations of this Command.
+-
+ getProcessedHelp
+ - Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
+-
+ getSynopsis
+ - Returns the synopsis for the command.
+-
+ getUsages
+ - Returns alternative usages of the command.
+-
+ ignoreValidationErrors
+ - Ignores validation errors.
+-
+ isEnabled
+ - Checks whether the command is enabled or not in the current environment.
+-
+ isHidden
+
+-
+ mergeApplicationDefinition
+ - Merges the application definition with the command definition.
+-
+ run
+ - Runs the command.
+-
+ setAliases
+ - Sets the aliases for the command.
+-
+ setApplication
+
+-
+ setCode
+ - Sets the code to execute when running this command.
+-
+ setDefinition
+ - Sets an array of argument and option instances.
+-
+ setDescription
+ - Sets the description for the command.
+-
+ setHelp
+ - Sets the help for the command.
+-
+ setHelperSet
+
+-
+ setHidden
+
+-
+ setName
+ - Sets the name of the command.
+-
+ setProcessTitle
+ - Sets the process title of the command.
+
+
+
+Constants:
+
+
+
+
+
+
+Method details:
+
+
+
+
+
+```php
+// Implemented in BumbleDocGen\Console\Command\BaseCommand
+
+public function __construct(string|null $name = NULL);
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string | null |
+ The name of the command; passing null means it must be set in configure() |
+
+
+
+
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addArgument(string $name, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an argument.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $mode |
+ int | null |
+ The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (for InputArgument::OPTIONAL mode only) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addOption(string $name, string|array|null $shortcut = NULL, int|null $mode = NULL, string $description = '', mixed $default = NULL): static;
+```
+
+
Adds an option.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+ | $shortcut |
+ string | array | null |
+ The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts |
+
+
+ | $mode |
+ int | null |
+ The option mode: One of the InputOption::VALUE_* constants |
+
+
+ | $description |
+ string |
+ - |
+
+
+ | $default |
+ mixed |
+ The default value (must be null for InputOption::VALUE_NONE) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function addUsage(string $usage): static;
+```
+
+
Add a command usage example, it'll be prefixed with the command name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $usage |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function complete(\Symfony\Component\Console\Completion\CompletionInput $input, \Symfony\Component\Console\Completion\CompletionSuggestions $suggestions): void;
+```
+
+
Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+
+
Parameters:
+
+
+
+
Return value: void
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getAliases(): array;
+```
+
+
Returns the aliases for the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getApplication(): \Symfony\Component\Console\Application|null;
+```
+
+
Gets the application instance for this command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Application |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultDescription(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public static function getDefaultName(): string|null;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition attached to this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getDescription(): string;
+```
+
+
Returns the description for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelp(): string;
+```
+
+
Returns the help for the command.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelper(string $name): mixed;
+```
+
+
Gets a helper instance by name.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: mixed
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getHelperSet(): \Symfony\Component\Console\Helper\HelperSet|null;
+```
+
+
Gets the helper set.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Helper\HelperSet |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getName(): string|null;
+```
+
+
Returns the command name.
+
+
Parameters: not specified
+
+
Return value: string |
null
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getNativeDefinition(): \Symfony\Component\Console\Input\InputDefinition;
+```
+
+
Gets the InputDefinition to be used to create representations of this Command.
+
+
Parameters: not specified
+
+
Return value: \Symfony\Component\Console\Input\InputDefinition
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getProcessedHelp(): string;
+```
+
+
Returns the processed help for the command replacing the %command.name% and
+%command.full_name% patterns with the real values dynamically.
+
+
Parameters: not specified
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getSynopsis(bool $short = false): string;
+```
+
+
Returns the synopsis for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $short |
+ bool |
+ Whether to show the short version of the synopsis (with options folded) or not |
+
+
+
+
+
Return value: string
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function getUsages(): array;
+```
+
+
Returns alternative usages of the command.
+
+
Parameters: not specified
+
+
Return value: array
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function ignoreValidationErrors(): mixed;
+```
+
+
Ignores validation errors.
+
+
Parameters: not specified
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isEnabled(): bool;
+```
+
+
Checks whether the command is enabled or not in the current environment.
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function isHidden(): bool;
+```
+
+
+
+
Parameters: not specified
+
+
Return value: bool
+
+
+
+
+
+
+- #
+ mergeApplicationDefinition
+ :warning: Is internal | source code
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function mergeApplicationDefinition(bool $mergeArgs = true): mixed;
+```
+
+
Merges the application definition with the command definition.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $mergeArgs |
+ bool |
+ Whether to merge or not the Application definition arguments to Command definition arguments |
+
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): int;
+```
+
+
Runs the command.
+
+
Parameters:
+
+
+
+
Return value: int
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setAliases(iterable $aliases): static;
+```
+
+
Sets the aliases for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $aliases |
+ iterable |
+ An array of aliases for the command |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setApplication(\Symfony\Component\Console\Application|null $application = NULL): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setCode(callable $code): static;
+```
+
+
Sets the code to execute when running this command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $code |
+ callable |
+ A callable(InputInterface $input, OutputInterface $output) |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
See:
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDefinition(array|\Symfony\Component\Console\Input\InputDefinition $definition): static;
+```
+
+
Sets an array of argument and option instances.
+
+
Parameters:
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setDescription(string $description): static;
+```
+
+
Sets the description for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $description |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelp(string $help): static;
+```
+
+
Sets the help for the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $help |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet): mixed;
+```
+
+
+
+
Parameters:
+
+
+
+
Return value: mixed
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setHidden(bool $hidden = true): static;
+```
+
+
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $hidden |
+ bool |
+ Whether or not the command should be hidden from the list of commands |
+
+
+
+
+
Return value: static
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setName(string $name): static;
+```
+
+
Sets the name of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $name |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
Throws:
+
+
+
+
+
+
+
+```php
+// Implemented in Symfony\Component\Console\Command\Command
+
+public function setProcessTitle(string $title): static;
+```
+
+
Sets the process title of the command.
+
+
Parameters:
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | $title |
+ string |
+ - |
+
+
+
+
+
Return value: static
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/tech/classes/MethodEntity.md b/docs/tech/classes/MethodEntity.md
index 058fe96b..9ea85bf7 100644
--- a/docs/tech/classes/MethodEntity.md
+++ b/docs/tech/classes/MethodEntity.md
@@ -2,7 +2,7 @@
@@ -219,7 +219,7 @@ class MethodEntity extends \BumbleDocGen\LanguageHandler\Php\Parser\Entity\BaseE
```php
@@ -354,7 +354,7 @@ public function getAbsoluteFileName(): string|null;
```php
@@ -438,7 +438,7 @@ public function getCachedEntityDependencies(): array;
```php
@@ -508,7 +508,7 @@ public function getDescriptionLinks(): array;
```php
@@ -562,7 +562,7 @@ public function getDocBlock(bool $recursive = true): \phpDocumentor\Reflection\D
```php
@@ -593,7 +593,7 @@ public function getDocComment(): string;
```php
@@ -630,7 +630,7 @@ public function getDocCommentEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\
```php
@@ -661,7 +661,7 @@ public function getDocCommentLine(): int|null;
```php
@@ -698,7 +698,7 @@ public function getDocCommentLineRecursive(): int|null;
```php
@@ -758,7 +758,7 @@ public function getDocNote(): string;
```php
@@ -812,7 +812,7 @@ public function getExamples(): array;
```php
@@ -913,7 +913,7 @@ public function getFirstExample(): string;
```php
@@ -944,7 +944,7 @@ public function getFirstReturnValue(): mixed;
```php
@@ -965,7 +965,7 @@ public function getImplementingClass(): \BumbleDocGen\LanguageHandler\Php\Parser
```php
@@ -986,7 +986,7 @@ public function getImplementingClassName(): string;
```php
@@ -1017,7 +1017,7 @@ public function getImplementingReflectionClass(): \Roave\BetterReflection\Reflec
```php
@@ -1048,7 +1048,7 @@ public function getModifiersString(): string;
```php
@@ -1069,7 +1069,7 @@ public function getName(): string;
```php
@@ -1123,7 +1123,7 @@ public function getObjectId(): string;
```php
@@ -1163,7 +1163,7 @@ public function getParameters(): array;
```php
@@ -1200,7 +1200,7 @@ public function getParametersString(): string;
```php
@@ -1221,7 +1221,7 @@ public function getPhpHandlerSettings(): \BumbleDocGen\LanguageHandler\Php\PhpHa
```php
@@ -1258,7 +1258,7 @@ public function getPrototype(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\
```php
@@ -1295,7 +1295,7 @@ public function getReturnType(): string;
```php
@@ -1316,7 +1316,7 @@ public function getRootEntity(): \BumbleDocGen\LanguageHandler\Php\Parser\Entity
```php
@@ -1337,7 +1337,7 @@ public function getRootEntityCollection(): \BumbleDocGen\LanguageHandler\Php\Par
```php
@@ -1358,7 +1358,7 @@ public function getShortName(): string;
```php
@@ -1395,7 +1395,7 @@ public function getSignature(): string;
```php
@@ -1426,7 +1426,7 @@ public function getStartColumn(): int;
```php
@@ -1566,7 +1566,7 @@ public function hasThrows(): bool;
```php
@@ -1610,7 +1610,7 @@ public function isDeprecated(): bool;
```php
@@ -1694,7 +1694,7 @@ public function isEntityFileCanBeLoad(): bool;
```php
@@ -1715,7 +1715,7 @@ public function isImplementedInParentClass(): bool;
```php
@@ -1775,7 +1775,7 @@ public function isInternal(): bool;
```php
@@ -1806,7 +1806,7 @@ public function isPrivate(): bool;
```php
@@ -1837,7 +1837,7 @@ public function isProtected(): bool;
```php
@@ -1868,7 +1868,7 @@ public function isPublic(): bool;
```php
@@ -1899,7 +1899,7 @@ public function isStatic(): bool;
```php
diff --git a/docs/tech/classes/ProgressBarFactory.md b/docs/tech/classes/ProgressBarFactory.md
index c9a5b346..15106c73 100644
--- a/docs/tech/classes/ProgressBarFactory.md
+++ b/docs/tech/classes/ProgressBarFactory.md
@@ -2,7 +2,7 @@
@@ -10,7 +10,7 @@
```php
-namespace BumbleDocGen\Core\Console;
+namespace BumbleDocGen\Console\ProgressBar;
final class ProgressBarFactory
```
@@ -51,7 +51,7 @@ final class ProgressBarFactory
```php
@@ -88,18 +88,18 @@ public function __construct(\Symfony\Component\Console\Style\OutputStyle $io);
```php
-public function createStylizedProgressBar(): \BumbleDocGen\Core\Console\StylizedProgressBar;
+public function createStylizedProgressBar(): \BumbleDocGen\Console\ProgressBar\StylizedProgressBar;
```
Parameters: not specified
-Return value: \BumbleDocGen\Core\Console\StylizedProgressBar
+Return value: \BumbleDocGen\Console\ProgressBar\StylizedProgressBar
diff --git a/docs/tech/classes/RendererIteratorFactory.md b/docs/tech/classes/RendererIteratorFactory.md
index b2d049e7..5ca58c0c 100644
--- a/docs/tech/classes/RendererIteratorFactory.md
+++ b/docs/tech/classes/RendererIteratorFactory.md
@@ -61,7 +61,7 @@ final class RendererIteratorFactory
```php
-public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $configurationParameterBag, \BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache $sharedCompressedDocumentFileCache, \BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Console\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Monolog\Logger $logger);
+public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrappersCollection $documentedEntityWrappersCollection, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $configurationParameterBag, \BumbleDocGen\Core\Cache\SharedCompressedDocumentFileCache $sharedCompressedDocumentFileCache, \BumbleDocGen\Core\Renderer\RendererHelper $rendererHelper, \BumbleDocGen\Core\Renderer\Context\Dependency\RendererDependencyFactory $dependencyFactory, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Console\ProgressBar\ProgressBarFactory $progressBarFactory, \Symfony\Component\Console\Style\OutputStyle $io, \Monolog\Logger $logger);
```
@@ -124,7 +124,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext
| $progressBarFactory |
- \BumbleDocGen\Core\Console\ProgressBarFactory |
+ \BumbleDocGen\Console\ProgressBar\ProgressBarFactory |
- |
diff --git a/docs/tech/classes/StylizedProgressBar.md b/docs/tech/classes/StylizedProgressBar.md
index 67bf85e1..d8acc8e1 100644
--- a/docs/tech/classes/StylizedProgressBar.md
+++ b/docs/tech/classes/StylizedProgressBar.md
@@ -2,7 +2,7 @@
@@ -10,7 +10,7 @@
```php
-namespace BumbleDocGen\Core\Console;
+namespace BumbleDocGen\Console\ProgressBar;
final class StylizedProgressBar
```
@@ -69,7 +69,7 @@ final class StylizedProgressBar
```php
@@ -106,7 +106,7 @@ public function __construct(\Symfony\Component\Console\Style\OutputStyle $io);
```php
@@ -144,7 +144,7 @@ public function advance(int $step): void;
```php
@@ -165,7 +165,7 @@ public function finish(): void;
```php
@@ -208,7 +208,7 @@ public function iterate(iterable $iterable, int|null $max = NULL): \Generator;
```php
@@ -246,7 +246,7 @@ public function setMaxSteps(int $maxSteps): void;
```php
@@ -284,7 +284,7 @@ public function setName(string $name): void;
```php
@@ -322,7 +322,7 @@ public function setStepDescription(string $stepDescription): void;
```php
diff --git a/docs/tech/map.md b/docs/tech/map.md
index 0a5405af..9e5a267d 100644
--- a/docs/tech/map.md
+++ b/docs/tech/map.md
@@ -5,7 +5,15 @@ Directory layout ( only documented files shown ):