Skip to content

Commit

Permalink
Updating doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@shcherbanich
shcherbanich committed Oct 27, 2023
1 parent 6d7fc06 commit 16851e1
Show file tree
Hide file tree
Showing 34 changed files with 891 additions and 164 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> Thu Oct 5 17:42:06 2023 +0300<br><b>Page content update date:</b> Thu Oct 19 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> 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>
25 changes: 15 additions & 10 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#L34">DocGenerator</a> class:
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L37">DocGenerator</a> class:
</h1>


Expand Down Expand Up @@ -55,11 +55,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#L37">source
<code>LOG_FILE_NAME</code> <b>|</b> <a href="/src/DocGenerator.php#L40">source
code</a> </li>
<li><a name="qversion"
href="#qversion">#</a>
<code>VERSION</code> <b>|</b> <a href="/src/DocGenerator.php#L36">source
<code>VERSION</code> <b>|</b> <a href="/src/DocGenerator.php#L39">source
code</a> </li>
</ul>

Expand All @@ -74,11 +74,11 @@ 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#L39">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L42">source code</a></li>
</ul>

```php
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\Parser\Entity\RootEntityCollectionsGroup $rootEntityCollectionsGroup, \Monolog\Logger $logger);
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);
```


Expand Down Expand Up @@ -128,6 +128,11 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo
<td>$renderer</td>
<td><a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Renderer/Renderer.php'>\BumbleDocGen\Core\Renderer\Renderer</a></td>
<td>-</td>
</tr>
<tr>
<td>$generationErrorsHandler</td>
<td><a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Logger/Handler/GenerationErrorsHandler.php'>\BumbleDocGen\Core\Logger\Handler\GenerationErrorsHandler</a></td>
<td>-</td>
</tr>
<tr>
<td>$rootEntityCollectionsGroup</td>
Expand All @@ -151,7 +156,7 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo
<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#L140">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L144">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -191,7 +196,7 @@ public function addMissingDocBlocks(): void;
<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#L229">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L233">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -231,7 +236,7 @@ public function fillInReadmeMdTemplate(): void;
<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#L312">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L316">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -262,7 +267,7 @@ public function generate(): void;
<ul>
<li><a name="mgenerateprojecttemplatesstructure" href="#mgenerateprojecttemplatesstructure">#</a>
<b>generateProjectTemplatesStructure</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L79">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L83">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -302,7 +307,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#L64">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php#L68">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.

18 changes: 14 additions & 4 deletions docs/tech/1.configuration/classes/PageHtmlLinkerPlugin.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> <a href="/docs/tech/readme.md">Technical description of the project</a> <b>/</b> <a href="/docs/tech/1.configuration/readme.md">Configuration files</a> <b>/</b> PageHtmlLinkerPlugin<hr> </embed>

<h1>
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageHtmlLinkerPlugin.php#L23">PageHtmlLinkerPlugin</a> class:
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/PageHtmlLinkerPlugin.php#L29">PageHtmlLinkerPlugin</a> class:
</h1>


Expand Down Expand Up @@ -32,6 +32,16 @@ final class PageHtmlLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\Pa

```

```php
<a x-title="Custom title">\Namespace\ClassName</a> => <a href="/docs/some/page/ClassName.md">Custom title</a>

```

```php
<a>\Namespace\ClassName</a> => <a href="/docs/some/page/ClassName.md">\Namespace\ClassName</a>

```

```php
<a>Non-existent page name</a> => Non-existent page name

Expand Down Expand Up @@ -74,7 +84,7 @@ final class PageHtmlLinkerPlugin extends \BumbleDocGen\Core\Plugin\CorePlugin\Pa
<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/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L40">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L20">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -128,7 +138,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsH
<ul>
<li><a name="mbeforecreatingdocfile" href="#mbeforecreatingdocfile">#</a>
<b>beforeCreatingDocFile</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L61">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L73">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -184,7 +194,7 @@ public function beforeCreatingDocFile(\BumbleDocGen\Core\Plugin\Event\Renderer\B
<ul>
<li><a name="mgetsubscribedevents" href="#mgetsubscribedevents">#</a>
<b>getSubscribedEvents</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L48">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Plugin/CorePlugin/PageLinker/BasePageLinker.php#L60">source code</a></li>
</ul>

```php
Expand Down
2 changes: 1 addition & 1 deletion docs/tech/1.configuration/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,4 @@ The inheritance algorithm is as follows: scalar types can be overwritten by each

<div id='page_committer_info'>
<hr>
<b>Last page committer:</b> fshcherbanich &lt;[email protected]&gt;<br><b>Last modified date:</b> Thu Oct 5 17:42:06 2023 +0300<br><b>Page content update date:</b> Thu Oct 19 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> Thu Oct 5 17:42:06 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>
Loading

0 comments on commit 16851e1

Please sign in to comment.