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 19, 2023
1 parent 0e9182b commit d6b95fe
Show file tree
Hide file tree
Showing 125 changed files with 365 additions and 355 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> 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> 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>
4 changes: 2 additions & 2 deletions docs/classes/DocGenerator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/DocGeneratorFactory.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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');
```


Expand Down
4 changes: 2 additions & 2 deletions docs/classes/InvalidConfigurationParameterException.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/ReflectionException.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/shared_c.cache
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/tech/1.configuration/classes/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\ConfigurationParame
</tr>
<tr>
<td>$logger</td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>Psr\Log\LoggerInterface</a></td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>\Psr\Log\LoggerInterface</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/tech/1.configuration/classes/DrawDocumentationMenu.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
</ul>

```php
public function __invoke(string|null $startPageKey = NULL, int|null $maxDeep = NULL): string;
public function __invoke(string|null $startPageKey = null, int|null $maxDeep = null): string;
```


Expand Down
2 changes: 1 addition & 1 deletion docs/tech/1.configuration/classes/GetDocumentationPageUrl.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsH
</tr>
<tr>
<td>$logger</td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>Psr\Log\LoggerInterface</a></td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>\Psr\Log\LoggerInterface</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/1.configuration/classes/InvalidConfigurationParameterException.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/tech/1.configuration/classes/PageHtmlLinkerPlugin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public function __construct(\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsH
</tr>
<tr>
<td>$logger</td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>Psr\Log\LoggerInterface</a></td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>\Psr\Log\LoggerInterface</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/1.configuration/classes/ReflectionException.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
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> 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> 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>
2 changes: 1 addition & 1 deletion docs/tech/2.parser/classes/AsyncSourceLocator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ public function getSourceLocator(\Roave\BetterReflection\SourceLocator\Ast\Locat
<tbody>
<tr>
<td>$astLocator</td>
<td><a href='https://github.com/Roave/BetterReflection/blob/master/src/SourceLocator/Ast/Locator.php'>Roave\BetterReflection\SourceLocator\Ast\Locator</a></td>
<td><a href='https://github.com/Roave/BetterReflection/blob/master/src/SourceLocator/Ast/Locator.php'>\Roave\BetterReflection\SourceLocator\Ast\Locator</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/2.parser/classes/ClassEntity.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
</tr>
<tr>
<td>$logger</td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>Psr\Log\LoggerInterface</a></td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>\Psr\Log\LoggerInterface</a></td>
<td>-</td>
</tr>
<tr>
Expand Down Expand Up @@ -3084,7 +3084,7 @@ public function setReflectionClass(\Roave\BetterReflection\Reflection\Reflection
<tbody>
<tr>
<td>$reflectionClass</td>
<td><a href='https://github.com/Roave/BetterReflection/blob/master/src/Reflection/ReflectionClass.php'>Roave\BetterReflection\Reflection\ReflectionClass</a></td>
<td><a href='https://github.com/Roave/BetterReflection/blob/master/src/Reflection/ReflectionClass.php'>\Roave\BetterReflection\Reflection\ReflectionClass</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
6 changes: 3 additions & 3 deletions docs/tech/2.parser/classes/ClassEntityCollection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,12 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
</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>
<td>$logger</td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>Psr\Log\LoggerInterface</a></td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>\Psr\Log\LoggerInterface</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down Expand Up @@ -626,7 +626,7 @@ public function getEntityCollectionName(): string;
</ul>

```php
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = NULL, bool $useUnsafeKeys = true): array;
public function getEntityLinkData(string $rawLink, string|null $defaultEntityName = null, bool $useUnsafeKeys = true): array;
```


Expand Down
2 changes: 1 addition & 1 deletion docs/tech/2.parser/classes/ConstantEntity.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
</tr>
<tr>
<td>$logger</td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>Psr\Log\LoggerInterface</a></td>
<td><a href='https://github.com/php-fig/log/blob/master/src/LoggerInterface.php'>\Psr\Log\LoggerInterface</a></td>
<td>-</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/tech/2.parser/classes/DynamicMethodEntity.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
</tr>
<tr>
<td>$annotationMethod</td>
<td><a href='https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock/Tags/Method.php'>phpDocumentor\Reflection\DocBlock\Tags\Method</a></td>
<td><a href='https://github.com/phpDocumentor/ReflectionDocBlock/blob/master/src/DocBlock/Tags/Method.php'>\phpDocumentor\Reflection\DocBlock\Tags\Method</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/tech/2.parser/classes/FileIteratorSourceLocator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public function __construct(\Iterator $fileInfoIterator);
<tbody>
<tr>
<td>$fileInfoIterator</td>
<td><a href='https://www.php.net/manual/en/class.iterator.php'>Iterator</a></td>
<td><a href='https://www.php.net/manual/en/class.iterator.php'>\Iterator</a></td>
<td>-</td>
</tr>
</tbody>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/2.parser/classes/InvalidConfigurationParameterException.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/2.parser/classes/InvalidConfigurationParameterException_3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/tech/2.parser/classes/LocatedInCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ final class LocatedInCondition implements \BumbleDocGen\Core\Parser\FilterCondit
</ul>

```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = [ ]);
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = []);
```


Expand Down Expand Up @@ -132,7 +132,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf
<b>Throws:</b>
<ul>
<li>
<a href="/docs/tech/2.parser/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
<a href="/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>

</ul>

Expand Down
4 changes: 2 additions & 2 deletions docs/tech/2.parser/classes/LocatedNotInCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ final class LocatedNotInCondition implements \BumbleDocGen\Core\Parser\FilterCon
</ul>

```php
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = [ ]);
public function __construct(\BumbleDocGen\Core\Configuration\Configuration $configuration, \BumbleDocGen\Core\Configuration\ConfigurationParameterBag $parameterBag, array $directories = []);
```


Expand Down Expand Up @@ -132,7 +132,7 @@ public function canAddToCollection(\BumbleDocGen\Core\Parser\Entity\EntityInterf
<b>Throws:</b>
<ul>
<li>
<a href="/docs/tech/2.parser/classes/InvalidConfigurationParameterException.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>
<a href="/docs/tech/2.parser/classes/InvalidConfigurationParameterException_2.md">\BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException</a></li>

</ul>

Expand Down
Loading

0 comments on commit d6b95fe

Please sign in to comment.