DocBlocksGenerator.md

BumbleDocGen / Technical description of the project / Class map / DocBlocksGenerator

---

DocBlocksGenerator class:

namespace BumbleDocGen\AI\Generators;

final class DocBlocksGenerator

Initialization methods:

1. __construct

Methods:

1. generateDocBlocksForMethodsWithoutIt
2. hasMethodsWithoutDocBlocks

Constants:

• # MODE_READ_ALL_CODE | source code
• # MODE_READ_ONLY_SIGNATURES | source code

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\AI\ProviderInterface $aiProvider, \BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper $parserHelper);

Parameters:

Name	Type	Description
$aiProvider	\BumbleDocGen\AI\ProviderInterface	-
$parserHelper	\BumbleDocGen\LanguageHandler\Php\Parser\ParserHelper	-

---

• # generateDocBlocksForMethodsWithoutIt | source code

public function generateDocBlocksForMethodsWithoutIt(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity, int $mode = self::MODE_READ_ONLY_SIGNATURES): array;

Parameters:

Name	Type	Description
$rootEntity	\BumbleDocGen\Core\Parser\Entity\RootEntityInterface	-
$mode	int	-

Return value: array

Throws:

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

---

• # hasMethodsWithoutDocBlocks | source code

public function hasMethodsWithoutDocBlocks(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity): bool;

Parameters:

Name	Type	Description
$rootEntity	\BumbleDocGen\Core\Parser\Entity\RootEntityInterface	-

Return value: bool

Throws:

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

---