Merge pull request #60 from bumble-tech/1.x.x

v1.4.0

SECURITY.md

@@ -8,10 +8,11 @@ Security updates will be applied to certain versions of our software. Please ref
 
 | Version | Supported          | Notes                                  |
 |---------|--------------------|----------------------------------------|
-| 1.3.x   | :white_check_mark: | Current version, fully supported.      |
-| 1.2.x   | :x:                | Not supported, please upgrade to 1.3.x |
-| 1.1.x   | :x:                | Not supported, please upgrade to 1.3.x |
-| 1.0.x   | :x:                | Not supported, please upgrade to 1.3.x |
+| 1.4.x   | :white_check_mark: | Current version, fully supported.      |
+| 1.3.x   | :x:                | Not supported, please upgrade to 1.4.x |
+| 1.2.x   | :x:                | Not supported, please upgrade to 1.4.x |
+| 1.1.x   | :x:                | Not supported, please upgrade to 1.4.x |
+| 1.0.x   | :x:                | Not supported, please upgrade to 1.4.x |
 
 ## Reporting a Vulnerability
 

bumble_doc_gen.yaml

@@ -22,6 +22,6 @@ twig_functions:
   - class: \SelfDocConfig\Twig\CustomFunction\PrintClassCollectionAsGroupedTable
   - class: \SelfDocConfig\Twig\CustomFunction\GetConfigParametersDescription
 plugins:
-  - class: \SelfDocConfig\Plugin\RoaveStubber\BetterReflectionStubberPlugin
   - class: \SelfDocConfig\Plugin\TwigFilterClassParser\TwigFilterClassParserPlugin
   - class: \SelfDocConfig\Plugin\TwigFunctionClassParser\TwigFunctionClassParserPlugin
+  - class: \BumbleDocGen\Core\Plugin\CorePlugin\LastPageCommitter\LastPageCommitter

demo/demo1/templates/sectionWithSubsections/pageLinkingExample/index.md.twig

@@ -3,12 +3,9 @@
 
 {{ "Page linking example" | textToHeading('H1') }}
 
-1) <a>InvalidArgumentException</a> - create a reference by short class name
-
-2) <a>Doctrine\Common\Annotations\AnnotationException</a> - creating a reference by full class name
-
-3) <a>Class map</a> - create a link to another page
-
-4) <a>/demo/demo1/docs/sectionWithSubsections/classListExample/index.md</a> - creating a link by file path
-
-5) <a>/demo/demo1/docs/sectionWithSubsections/classListExample/index2.md</a> - non-exists link case
+1) [a]InvalidArgumentException[/a] - create a reference by short class name
+2) [a]Doctrine\Common\Annotations\AnnotationException[/a] - creating a reference by full class name
+3) [a x-title='Custom title']Doctrine\Common\Annotations\AnnotationException[/a] - creating a reference by full class name with custom title
+4) [a]Class map[/a] - create a link to another page
+5) [a]/demo/demo1/docs/sectionWithSubsections/classListExample/index.md[/a] - creating a link by file path
+6) [a]/demo/demo1/docs/sectionWithSubsections/classListExample/index2.md[/a] - non-exists link case

docs/README.md

@@ -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> Sun Oct 15 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>

docs/classes/DocGenerator.md

@@ -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>
 
 
@@ -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>
 
@@ -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);
 ```
 
 
@@ -96,12 +96,12 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo
     <tbody>
             <tr>
             <td>$fs</td>
-            <td><a href='https://github.com/symfony/filesystem/blob/master/Filesystem.php'>Symfony\Component\Filesystem\Filesystem</a></td>
+            <td><a href='https://github.com/symfony/filesystem/blob/master/Filesystem.php'>\Symfony\Component\Filesystem\Filesystem</a></td>
             <td>-</td>
         </tr>
             <tr>
             <td>$io</td>
-            <td><a href='https://github.com/symfony/console/blob/master/Style/OutputStyle.php'>Symfony\Component\Console\Style\OutputStyle</a></td>
+            <td><a href='https://github.com/symfony/console/blob/master/Style/OutputStyle.php'>\Symfony\Component\Console\Style\OutputStyle</a></td>
             <td>-</td>
         </tr>
             <tr>
@@ -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>
@@ -136,7 +141,7 @@ public function __construct(\Symfony\Component\Filesystem\Filesystem $fs, \Symfo
         </tr>
             <tr>
             <td>$logger</td>
-            <td>\Monolog\Logger</td>
+            <td><a href='https://github.com/Seldaek/monolog/blob/master/src/Monolog/Logger.php'>\Monolog\Logger</a></td>
             <td>-</td>
         </tr>
         </tbody>
@@ -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
@@ -168,10 +173,10 @@ public function addMissingDocBlocks(): void;
 <b>Throws:</b>
 <ul>
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\DI\NotFoundException</a></li>
 
 <li>
-    <a >\DI\DependencyException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
     <a href="/docs/classes/ReflectionException.md">\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException</a></li>
@@ -180,7 +185,7 @@ public function addMissingDocBlocks(): void;
     <a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
 
 <li>
-    <a >\Tectalic\OpenAi\ClientException</a></li>
+    <a href="https://github.com/tectalichq/public-openai-client-php/blob/master/src/ClientException.php">\Tectalic\OpenAi\ClientException</a></li>
 
 </ul>
 
@@ -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
@@ -211,13 +216,13 @@ public function fillInReadmeMdTemplate(): void;
     <a href="/docs/classes/ReflectionException.md">\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException</a></li>
 
 <li>
-    <a >\DI\DependencyException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
-    <a >\Tectalic\OpenAi\ClientException</a></li>
+    <a href="https://github.com/tectalichq/public-openai-client-php/blob/master/src/ClientException.php">\Tectalic\OpenAi\ClientException</a></li>
 
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\DI\NotFoundException</a></li>
 
 <li>
     <a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
@@ -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#L311">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
@@ -250,6 +255,9 @@ public function generate(): void;
 <li>
     <a href="https://github.com/php-fig/cache/blob/master/src/InvalidArgumentException.php">\Psr\Cache\InvalidArgumentException</a></li>
 
+<li>
+    <a href="https://www.php.net/manual/en/class.exception.php">\Exception</a></li>
+
 </ul>
 
 </div>
@@ -259,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
@@ -276,16 +284,16 @@ public function generateProjectTemplatesStructure(): void;
 <b>Throws:</b>
 <ul>
 <li>
-    <a >\Tectalic\OpenAi\ClientException</a></li>
+    <a href="https://github.com/tectalichq/public-openai-client-php/blob/master/src/ClientException.php">\Tectalic\OpenAi\ClientException</a></li>
 
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\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>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
     <a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
@@ -299,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
@@ -316,10 +324,10 @@ public function parseAndGetRootEntityCollectionsGroup(): \BumbleDocGen\Core\Pars
 <b>Throws:</b>
 <ul>
 <li>
-    <a >\DI\DependencyException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\DI\NotFoundException</a></li>
 
 <li>
     <a href="/docs/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>

docs/classes/DocGeneratorFactory.md

@@ -67,7 +67,7 @@ final class DocGeneratorFactory
 </ul>
 
 ```php
-public function __construct(string $diConfig = '/src/di-config.php');
+public function __construct(string $diConfig = __DIR__ . '/di-config.php');
 ```
 
 
@@ -134,10 +134,10 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen
 <b>Throws:</b>
 <ul>
 <li>
-    <a >\DI\DependencyException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\DI\NotFoundException</a></li>
 
 <li>
     <a href="https://www.php.net/manual/en/class.exception.php">\Exception</a></li>
@@ -185,10 +185,10 @@ public function createByConfigArray(array $config): \BumbleDocGen\DocGenerator;
 <b>Throws:</b>
 <ul>
 <li>
-    <a >\DI\DependencyException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\DI\NotFoundException</a></li>
 
 <li>
     <a href="https://www.php.net/manual/en/class.exception.php">\Exception</a></li>
@@ -236,10 +236,10 @@ public function createConfiguration(string ...$configurationFiles): \BumbleDocGe
 <b>Throws:</b>
 <ul>
 <li>
-    <a >\DI\DependencyException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/DependencyException.php">\DI\DependencyException</a></li>
 
 <li>
-    <a >\DI\NotFoundException</a></li>
+    <a href="https://github.com/PHP-DI/PHP-DI/blob/master/src/NotFoundException.php">\DI\NotFoundException</a></li>
 
 <li>
     <a href="https://www.php.net/manual/en/class.exception.php">\Exception</a></li>

docs/classes/InvalidConfigurationParameterException.md

@@ -88,7 +88,7 @@ See:
 ```php
 // Implemented in Exception
 
-public function __construct(string $message = '', int $code, \Throwable|null $previous = NULL);
+public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
 ```
 
 <blockquote>Construct the exception. Note: The message is NOT binary safe.</blockquote>
@@ -116,7 +116,7 @@ public function __construct(string $message = '', int $code, \Throwable|null $pr
         </tr>
             <tr>
             <td>$previous</td>
-            <td><a href='https://www.php.net/manual/en/class.throwable.php'>Throwable</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
+            <td><a href='https://www.php.net/manual/en/class.throwable.php'>\Throwable</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
             <td>[optional] The previous throwable used for the exception chaining.</td>
         </tr>
         </tbody>

docs/classes/ReflectionException.md

@@ -88,7 +88,7 @@ See:
 ```php
 // Implemented in Exception
 
-public function __construct(string $message = '', int $code, \Throwable|null $previous = NULL);
+public function __construct(string $message = "", int $code, \Throwable|null $previous = \null);
 ```
 
 <blockquote>Construct the exception. Note: The message is NOT binary safe.</blockquote>
@@ -116,7 +116,7 @@ public function __construct(string $message = '', int $code, \Throwable|null $pr
         </tr>
             <tr>
             <td>$previous</td>
-            <td><a href='https://www.php.net/manual/en/class.throwable.php'>Throwable</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
+            <td><a href='https://www.php.net/manual/en/class.throwable.php'>\Throwable</a> | <a href='https://www.php.net/manual/en/language.types.null.php'>null</a></td>
             <td>[optional] The previous throwable used for the exception chaining.</td>
         </tr>
         </tbody>