ReadmeTemplateGenerator.md

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

---

ReadmeTemplateGenerator class:

namespace BumbleDocGen\AI\Generators;

final class ReadmeTemplateGenerator

Initialization methods:

1. __construct

Methods:

1. generateReadmeFileContent

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\AI\ProviderInterface $aiProvider);

Parameters:

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

---

• # generateReadmeFileContent | source code

public function generateReadmeFileContent(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection, array $entryPoints = [], string|null $composerJsonFile = null, string|null $additionalPrompt = null): string;

Parameters:

Name	Type	Description
$rootEntityCollection	\BumbleDocGen\Core\Parser\Entity\RootEntityCollection	-
$entryPoints	array	-
$composerJsonFile	string | null	-
$additionalPrompt	string | null	-

Return value: string

Throws:

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

---