Skip to content

Commit

Permalink
Update documentation after merge
Browse files Browse the repository at this point in the history
  • Loading branch information
@seanmcn
seanmcn committed Oct 31, 2023
1 parent a9674c3 commit aa5bb00
Show file tree
Hide file tree
Showing 41 changed files with 2,851 additions and 1,132 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ To update this documentation, run the following command:

<div id='page_committer_info'>
<hr>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Fri Oct 27 15:10:16 2023 +0300<br><b>Page content update date:</b> Fri Oct 27 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Sat Oct 28 11:03:31 2023 +0300<br><b>Page content update date:</b> Tue Oct 31 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
259 changes: 211 additions & 48 deletions docs/classes/DocGenerator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<embed> <a href="/docs/README.md">BumbleDocGen</a> <b>/</b> DocGenerator<hr> </embed>

<h1>
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L37">DocGenerator</a> class:
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L41">DocGenerator</a> class:
</h1>


Expand Down Expand Up @@ -34,16 +34,19 @@ final class DocGenerator

<ol>
<li>
<a href="#maddmissingdocblocks">addMissingDocBlocks</a>
<a href="#madddocblocks">addDocBlocks</a>
- <i>Generate missing docBlocks with ChatGPT for project class methods that are available for documentation</i></li>
<li>
<a href="#mfillinreadmemdtemplate">fillInReadmeMdTemplate</a>
</li>
<li>
<a href="#mgenerate">generate</a>
- <i>Generates documentation using configuration</i></li>
<li>
<a href="#mgenerateprojecttemplatesstructure">generateProjectTemplatesStructure</a>
<a href="#mgeneratereadmetemplate">generateReadmeTemplate</a>
</li>
<li>
<a href="#mgeneratetemplatescontent">generateTemplatesContent</a>
</li>
<li>
<a href="#minitdocsstructure">initDocsStructure</a>
- <i>Generate documentation structure with blank templates using AI tools</i></li>
<li>
<a href="#mparseandgetrootentitycollectionsgroup">parseAndGetRootEntityCollectionsGroup</a>
Expand All @@ -55,11 +58,11 @@ final class DocGenerator
<ul>
<li><a name="qlog-file-name"
href="#qlog-file-name">#</a>
<code>LOG_FILE_NAME</code> <b>|</b> <a href="/src/DocGenerator.php#L40">source
<code>LOG_FILE_NAME</code> <b>|</b> <a href="/src/DocGenerator.php#L44">source
code</a> </li>
<li><a name="qversion"
href="#qversion">#</a>
<code>VERSION</code> <b>|</b> <a href="/src/DocGenerator.php#L39">source
<code>VERSION</code> <b>|</b> <a href="/src/DocGenerator.php#L43">source
code</a> </li>
</ul>

Expand All @@ -74,7 +77,7 @@ final class DocGenerator
<ul>
<li><a name="m-construct" href="#m-construct">#</a>
<b>__construct</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L42">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L46">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -154,18 +157,50 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo
<div class='method_description-block'>

<ul>
<li><a name="maddmissingdocblocks" href="#maddmissingdocblocks">#</a>
<b>addMissingDocBlocks</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L144">source code</a></li>
<li><a name="madddocblocks" href="#madddocblocks">#</a>
<b>addDocBlocks</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L156">source code</a></li>
</ul>

```php
public function addMissingDocBlocks(): void;
public function addDocBlocks(string $aiHandler, string $aiApiKey, string $aiModel, string|null $systemPrompt = null): void;
```

<blockquote>Generate missing docBlocks with ChatGPT for project class methods that are available for documentation</blockquote>

<b>Parameters:</b> not specified
<b>Parameters:</b>

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>$aiHandler</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiApiKey</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiModel</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$systemPrompt</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
<td>-</td>
</tr>
</tbody>
</table>

<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>

Expand All @@ -184,8 +219,36 @@ public function addMissingDocBlocks(): void;
<li>
<a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>

</ul>

</div>
<hr>
<div class='method_description-block'>

<ul>
<li><a name="mgenerate" href="#mgenerate">#</a>
<b>generate</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L408">source code</a></li>
</ul>

```php
public function generate(): void;
```

<blockquote>Generates documentation using configuration</blockquote>

<b>Parameters:</b> not specified

<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>


<b>Throws:</b>
<ul>
<li>
<a href="https://github.com/php-fig/cache/blob/master/src/InvalidArgumentException.php">\Psr\Cache\InvalidArgumentException</a></li>

<li>
<a >\Tectalic\OpenAi\ClientException</a></li>
<a href="https://www.php.net/manual/en/class.exception.php">\Exception</a></li>

</ul>

Expand All @@ -194,18 +257,50 @@ public function addMissingDocBlocks(): void;
<div class='method_description-block'>

<ul>
<li><a name="mfillinreadmemdtemplate" href="#mfillinreadmemdtemplate">#</a>
<b>fillInReadmeMdTemplate</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L233">source code</a></li>
<li><a name="mgeneratereadmetemplate" href="#mgeneratereadmetemplate">#</a>
<b>generateReadmeTemplate</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L246">source code</a></li>
</ul>

```php
public function fillInReadmeMdTemplate(): void;
public function generateReadmeTemplate(string $aiHandler, string $aiApiKey, string $aiModel, string|null $systemPrompt = null): void;
```



<b>Parameters:</b> not specified
<b>Parameters:</b>

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>$aiHandler</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiApiKey</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiModel</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$systemPrompt</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
<td>-</td>
</tr>
</tbody>
</table>

<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>

Expand All @@ -218,9 +313,6 @@ public function fillInReadmeMdTemplate(): void;
<li>
<a >\DI\DependencyException</a></li>

<li>
<a >\Tectalic\OpenAi\ClientException</a></li>

<li>
<a >\DI\NotFoundException</a></li>

Expand All @@ -234,29 +326,75 @@ public function fillInReadmeMdTemplate(): void;
<div class='method_description-block'>

<ul>
<li><a name="mgenerate" href="#mgenerate">#</a>
<b>generate</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L316">source code</a></li>
<li><a name="mgeneratetemplatescontent" href="#mgeneratetemplatescontent">#</a>
<b>generateTemplatesContent</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L337">source code</a></li>
</ul>

```php
public function generate(): void;
public function generateTemplatesContent(string $aiHandler, string $aiApiKey, string $aiModel, bool $nonInteractive = false, string|null $systemPrompt = null): void;
```

<blockquote>Generates documentation using configuration</blockquote>

<b>Parameters:</b> not specified

<b>Parameters:</b>

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>$aiHandler</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiApiKey</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiModel</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$nonInteractive</td>
<td><a href='https://www.php.net/manual/en/language.types.boolean.php'>bool</a></td>
<td>-</td>
</tr>
<tr>
<td>$systemPrompt</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
<td>-</td>
</tr>
</tbody>
</table>

<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>


<b>Throws:</b>
<ul>
<li>
<a href="https://github.com/php-fig/cache/blob/master/src/InvalidArgumentException.php">\Psr\Cache\InvalidArgumentException</a></li>
<a href="/docs/classes/ReflectionException.md">\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException</a></li>

<li>
<a href="https://www.php.net/manual/en/class.exception.php">\Exception</a></li>
<a >\DI\DependencyException</a></li>

<li>
<a href="https://www.php.net/manual/en/class.jsonexception.php">\JsonException</a></li>

<li>
<a >\DI\NotFoundException</a></li>

<li>
<a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>

</ul>

Expand All @@ -265,36 +403,61 @@ public function generate(): void;
<div class='method_description-block'>

<ul>
<li><a name="mgenerateprojecttemplatesstructure" href="#mgenerateprojecttemplatesstructure">#</a>
<b>generateProjectTemplatesStructure</b>
<li><a name="minitdocsstructure" href="#minitdocsstructure">#</a>
<b>initDocsStructure</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L83">source code</a></li>
</ul>

```php
public function generateProjectTemplatesStructure(): void;
public function initDocsStructure(string $aiHandler, string $aiApiKey, string $aiModel, bool $nonInteractive = false, string|null $systemPrompt = null): void;
```

<blockquote>Generate documentation structure with blank templates using AI tools</blockquote>

<b>Parameters:</b> not specified
<b>Parameters:</b>

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>$aiHandler</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiApiKey</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$aiModel</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
<tr>
<td>$nonInteractive</td>
<td><a href='https://www.php.net/manual/en/language.types.boolean.php'>bool</a></td>
<td>-</td>
</tr>
<tr>
<td>$systemPrompt</td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
<td>-</td>
</tr>
</tbody>
</table>

<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>


<b>Throws:</b>
<ul>
<li>
<a >\Tectalic\OpenAi\ClientException</a></li>

<li>
<a >\DI\NotFoundException</a></li>

<li>
<a href="/docs/classes/ReflectionException.md">\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException</a></li>

<li>
<a >\DI\DependencyException</a></li>

<li>
<a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>

Expand All @@ -307,7 +470,7 @@ public function generateProjectTemplatesStructure(): void;
<ul>
<li><a name="mparseandgetrootentitycollectionsgroup" href="#mparseandgetrootentitycollectionsgroup">#</a>
<b>parseAndGetRootEntityCollectionsGroup</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L68">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L72">source code</a></li>
</ul>

```php
Expand Down
2 changes: 1 addition & 1 deletion docs/shared_c.cache
View file

Large diffs are not rendered by default.

Loading

0 comments on commit aa5bb00

Please sign in to comment.