Skip to content

Commit

Permalink
Merge pull request #7 from bumble-tech/1.x.x
Browse files Browse the repository at this point in the history 
v1.1.0
  • Loading branch information
@shcherbanich
shcherbanich authored Oct 2, 2023
2 parents a112fa8 + ea6a583 commit d0d2a75
Show file tree
Hide file tree
Showing 61 changed files with 6,684 additions and 405 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,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> Sun Sep 10 17:47:00 2023 +0300<br><b>Page content update date:</b> Sun Sep 10 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> Sun Sep 10 17:47:00 2023 +0300<br><b>Page content update date:</b> Thu Sep 28 2023<br>Made with <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md'>Bumble Documentation Generator</a></div>
103 changes: 99 additions & 4 deletions docs/classes/DocGeneratorFactory.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> DocGeneratorFactory<hr> </embed>

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


Expand Down Expand Up @@ -36,9 +36,15 @@ final class DocGeneratorFactory
<li>
<a href="#mcreate">create</a>
</li>
<li>
<a href="#mcreateconfiguration">createConfiguration</a>
</li>
<li>
<a href="#msetcustomconfigurationparameters">setCustomConfigurationParameters</a>
</li>
<li>
<a href="#msetcustomdidefinitions">setCustomDiDefinitions</a>
</li>
</ol>


Expand All @@ -54,7 +60,7 @@ final class DocGeneratorFactory
<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/DocGeneratorFactory.php#L18">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L21">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -91,7 +97,7 @@ public function __construct(string $diConfig = '/src/di-config.php');
<ul>
<li><a name="mcreate" href="#mcreate">#</a>
<b>create</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L37">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L45">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -122,6 +128,57 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen
<b>Return value:</b> <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGenerator.php'>\BumbleDocGen\DocGenerator</a>


<b>Throws:</b>
<ul>
<li>
<a >\DI\DependencyException</a></li>

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

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

</ul>

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

<ul>
<li><a name="mcreateconfiguration" href="#mcreateconfiguration">#</a>
<b>createConfiguration</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L66">source code</a></li>
</ul>

```php
public function createConfiguration(string ...$configurationFiles): \BumbleDocGen\Core\Configuration\Configuration;
```



<b>Parameters:</b>

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>$configurationFiles <i>(variadic)</i></td>
<td><a href='https://www.php.net/manual/en/language.types.string.php'>string</a></td>
<td>-</td>
</tr>
</tbody>
</table>

<b>Return value:</b> <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php'>\BumbleDocGen\Core\Configuration\Configuration</a>


<b>Throws:</b>
<ul>
<li>
Expand All @@ -142,7 +199,7 @@ public function create(string|null ...$configurationFiles): \BumbleDocGen\DocGen
<ul>
<li><a name="msetcustomconfigurationparameters" href="#msetcustomconfigurationparameters">#</a>
<b>setCustomConfigurationParameters</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L27">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L30">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -173,6 +230,44 @@ public function setCustomConfigurationParameters(array $customConfigurationParam
<b>Return value:</b> <a href='https://www.php.net/manual/en/language.types.void.php'>void</a>


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

<ul>
<li><a name="msetcustomdidefinitions" href="#msetcustomdidefinitions">#</a>
<b>setCustomDiDefinitions</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/DocGeneratorFactory.php#L35">source code</a></li>
</ul>

```php
public function setCustomDiDefinitions(array $definitions): void;
```



<b>Parameters:</b>

<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>$definitions</td>
<td><a href='https://www.php.net/manual/en/language.types.array.php'>array</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>


</div>
<hr>

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

Large diffs are not rendered by default.

75 changes: 56 additions & 19 deletions docs/tech/1.configuration/classes/Configuration.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> Configuration<hr> </embed>

<h1>
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L28">Configuration</a> class:
<a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L30">Configuration</a> class:
</h1>


Expand Down Expand Up @@ -33,6 +33,9 @@ final class Configuration
<h2>Methods:</h2>

<ol>
<li>
<a href="#mgetadditionalconsolecommands">getAdditionalConsoleCommands</a>
</li>
<li>
<a href="#mgetcachedir">getCacheDir</a>
</li>
Expand Down Expand Up @@ -88,7 +91,7 @@ final class Configuration
<ul>
<li><a name="qdefault-settings-file"
href="#qdefault-settings-file">#</a>
<code>DEFAULT_SETTINGS_FILE</code> <b>|</b> <a href="/src/Core/Configuration/Configuration.php#L30">source
<code>DEFAULT_SETTINGS_FILE</code> <b>|</b> <a href="/src/Core/Configuration/Configuration.php#L32">source
code</a> </li>
</ul>

Expand All @@ -103,7 +106,7 @@ final class Configuration
<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/Configuration/Configuration.php#L32">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L34">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -143,14 +146,48 @@ public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParame



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

<ul>
<li><a name="mgetadditionalconsolecommands" href="#mgetadditionalconsolecommands">#</a>
<b>getAdditionalConsoleCommands</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L344">source code</a></li>
</ul>

```php
public function getAdditionalConsoleCommands(): \BumbleDocGen\Console\Command\AdditionalCommandCollection;
```



<b>Parameters:</b> not specified

<b>Return value:</b> <a href='https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Console/Command/AdditionalCommandCollection.php'>\BumbleDocGen\Console\Command\AdditionalCommandCollection</a>


<b>Throws:</b>
<ul>
<li>
<a >\DI\DependencyException</a></li>

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

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

</ul>

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

<ul>
<li><a name="mgetcachedir" href="#mgetcachedir">#</a>
<b>getCacheDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L189">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L191">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -178,7 +215,7 @@ public function getCacheDir(): string|null;
<ul>
<li><a name="mgetdocgenlibdir" href="#mgetdocgenlibdir">#</a>
<b>getDocGenLibDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L332">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L334">source code</a></li>
</ul>

```php
Expand All @@ -199,7 +236,7 @@ public function getDocGenLibDir(): string;
<ul>
<li><a name="mgetgitclientpath" href="#mgetgitclientpath">#</a>
<b>getGitClientPath</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L235">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L237">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -227,7 +264,7 @@ public function getGitClientPath(): string;
<ul>
<li><a name="mgetlanguagehandlerscollection" href="#mgetlanguagehandlerscollection">#</a>
<b>getLanguageHandlersCollection</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L150">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L152">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -261,7 +298,7 @@ public function getLanguageHandlersCollection(): \BumbleDocGen\LanguageHandler\L
<ul>
<li><a name="mgetoutputdir" href="#mgetoutputdir">#</a>
<b>getOutputDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L102">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L104">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -289,7 +326,7 @@ public function getOutputDir(): string;
<ul>
<li><a name="mgetoutputdirbaseurl" href="#mgetoutputdirbaseurl">#</a>
<b>getOutputDirBaseUrl</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L134">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L136">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -317,7 +354,7 @@ public function getOutputDirBaseUrl(): string;
<ul>
<li><a name="mgetpagelinkprocessor" href="#mgetpagelinkprocessor">#</a>
<b>getPageLinkProcessor</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L217">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L219">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -351,7 +388,7 @@ public function getPageLinkProcessor(): \BumbleDocGen\Core\Renderer\PageLinkProc
<ul>
<li><a name="mgetplugins" href="#mgetplugins">#</a>
<b>getPlugins</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L171">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L173">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -385,7 +422,7 @@ public function getPlugins(): \BumbleDocGen\Core\Plugin\PluginsCollection;
<ul>
<li><a name="mgetprojectroot" href="#mgetprojectroot">#</a>
<b>getProjectRoot</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L43">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L45">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -413,7 +450,7 @@ public function getProjectRoot(): string;
<ul>
<li><a name="mgetsourcelocators" href="#mgetsourcelocators">#</a>
<b>getSourceLocators</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L59">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L61">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -447,7 +484,7 @@ public function getSourceLocators(): \BumbleDocGen\Core\Parser\SourceLocator\Sou
<ul>
<li><a name="mgettemplatesdir" href="#mgettemplatesdir">#</a>
<b>getTemplatesDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L77">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L79">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -475,7 +512,7 @@ public function getTemplatesDir(): string;
<ul>
<li><a name="mgettwigfilters" href="#mgettwigfilters">#</a>
<b>getTwigFilters</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L274">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L276">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -509,7 +546,7 @@ public function getTwigFilters(): \BumbleDocGen\Core\Renderer\Twig\Filter\Custom
<ul>
<li><a name="mgettwigfunctions" href="#mgettwigfunctions">#</a>
<b>getTwigFunctions</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L251">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L253">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -543,7 +580,7 @@ public function getTwigFunctions(): \BumbleDocGen\Core\Renderer\Twig\Function\Cu
<ul>
<li><a name="mgetworkingdir" href="#mgetworkingdir">#</a>
<b>getWorkingDir</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L323">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L325">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -571,7 +608,7 @@ public function getWorkingDir(): string;
<ul>
<li><a name="mischeckfileingitbeforecreatingdocenabled" href="#mischeckfileingitbeforecreatingdocenabled">#</a>
<b>isCheckFileInGitBeforeCreatingDocEnabled</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L309">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L311">source code</a></li>
</ul>

```php
Expand Down Expand Up @@ -599,7 +636,7 @@ public function isCheckFileInGitBeforeCreatingDocEnabled(): bool;
<ul>
<li><a name="musesharedcache" href="#musesharedcache">#</a>
<b>useSharedCache</b>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L295">source code</a></li>
<b>|</b> <a href="https://github.com/bumble-tech/bumble-doc-gen/blob/master/src/Core/Configuration/Configuration.php#L297">source code</a></li>
</ul>

```php
Expand Down
Loading

0 comments on commit d0d2a75

Please sign in to comment.