DocGenerator.md

BumbleDocGen / DocGenerator

---

DocGenerator class:

namespace BumbleDocGen;

final class DocGenerator

Class for generating documentation.

Initialization methods:

1. __construct

Methods:

1. addDocBlocks - Generate missing docBlocks with ChatGPT for project class methods that are available for documentation
2. generate - Generates documentation using configuration
3. generateReadmeTemplate
4. parseAndGetRootEntityCollectionsGroup

Constants:

• # LOG_FILE_NAME | source code
• # VERSION | source code

Method details:

• # __construct | source code

public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfony\Component\Console\Style\OutputStyle $io, \BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher, \BumbleDocGen\Core\Parser\ProjectParser $parser, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper, \BumbleDocGen\Core\Renderer\Renderer $renderer, \BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler $generationErrorsHandler, \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \Monolog\Logger $logger);

Parameters:

Name	Type	Description
$fs	\Symfony\Component\Filesystem\Filesystem	-
$io	\Symfony\Component\Console\Style\OutputStyle	-
$configuration	\BumbleDocGen\Core\Configuration\Configuration	-
$pluginEventDispatcher	\BumbleDocGen\Core\Plugin\PluginEventDispatcher	-
$parser	\BumbleDocGen\Core\Parser\ProjectParser	-
$parserHelper	\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper	-
$renderer	\BumbleDocGen\Core\Renderer\Renderer	-
$generationErrorsHandler	\BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler	-
$rootEntityCollectionsGroup	\BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup	-
$logger	\Monolog\Logger	-

---

• # addDocBlocks | source code

public function addDocBlocks(\BumbleDocGen\AI\ProviderInterface $aiProvider): void;

Generate missing docBlocks with ChatGPT for project class methods that are available for documentation

Parameters:

Name	Type	Description
$aiProvider	\BumbleDocGen\AI\ProviderInterface	-

Return value: void

Throws:

• \DI\NotFoundException
• \DI\DependencyException
• \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # generate | source code

public function generate(): void;

Generates documentation using configuration

Parameters: not specified

Return value: void

Throws:

• \Psr\Cache\InvalidArgumentException
• \Exception

---

• # generateReadmeTemplate | source code

public function generateReadmeTemplate(\BumbleDocGen\AI\ProviderInterface $aiProvider): void;

Parameters:

Name	Type	Description
$aiProvider	\BumbleDocGen\AI\ProviderInterface	-

Return value: void

Throws:

• \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
• \DI\DependencyException
• \DI\NotFoundException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # parseAndGetRootEntityCollectionsGroup | source code

public function parseAndGetRootEntityCollectionsGroup(): \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup;

Parameters: not specified

Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollectionsGroup

Throws:

• \DI\DependencyException
• \DI\NotFoundException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---