- - \ No newline at end of file diff --git a/docs/tech/3.renderer/classes/RootEntityInterface.md b/docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md similarity index 73% rename from docs/tech/3.renderer/classes/RootEntityInterface.md rename to docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md index 1ba150ef..5a9d1055 100644 --- a/docs/tech/3.renderer/classes/RootEntityInterface.md +++ b/docs/tech/03_renderer/01_howToCreateTemplates/classes/RootEntityInterface.md @@ -1,5 +1,4 @@ - - +
RootEntityInterface class:
@@ -12,7 +11,7 @@
```php
namespace BumbleDocGen\Core\Parser\Entity;
-interface RootEntityInterface extends \\BumbleDocGen\Core\Parser\Entity\EntityInterface implements \BumbleDocGen\Core\Parser\Entity\EntityInterface
+interface RootEntityInterface extends \BumbleDocGen\Core\Parser\Entity\EntityInterface
```
Since the documentation generator supports several programming languages,
@@ -27,12 +26,6 @@ their entities need to correspond to the same interfaces
Methods:
--
- entityCacheIsOutdated
-
--
- entityDataCanBeLoaded
- - Checking if it is possible to get the entity data
-
getAbsoluteFileName
- Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
@@ -42,24 +35,30 @@ their entities need to correspond to the same interfaces
-
getFileContent
--
- getFileName
- - Returns the relative path to a file if it can be retrieved and if the file is in the project directory
-
getFileSourceLink
-
getName
-
+ - Full name of the entity
-
getObjectId
-
+ - Entity object ID
+-
+ getRelativeFileName
+ - File name relative to project_root configuration parameter
-
getRootEntityCollection
- Get parent collection of entities
-
getShortName
+ - Short name of the entity
+-
+ isEntityCacheOutdated
+-
+ isEntityDataCanBeLoaded
+ - Checking if it is possible to get the entity data
-
isEntityNameValid
- Check if entity name is valid
@@ -69,6 +68,9 @@ their entities need to correspond to the same interfaces
-
isInGit
- The entity file is in the git repository
+-
+ normalizeClassName
+
@@ -81,67 +83,23 @@ their entities need to correspond to the same interfaces
-
-- #
- entityCacheIsOutdated
- | source code
-
-
-```php
-// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
-
-public function entityCacheIsOutdated(): bool;
-```
-
-
-
-Parameters: not specified
-
-Return value: bool
-
-
-
-
-
-
-
-- #
- entityDataCanBeLoaded
- | source code
-
-
-```php
-public function entityDataCanBeLoaded(): bool;
-```
-
-Checking if it is possible to get the entity data
-
-Parameters: not specified
-
-Return value: bool
-
-
-
-
-
-
- #
getAbsoluteFileName
- | source code
+ | source code
```php
// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
-public function getAbsoluteFileName(): string|null;
+public function getAbsoluteFileName(): null|string;
```
Returns the absolute path to a file if it can be retrieved and if the file is in the project directory
Parameters: not specified
-Return value: string | null
+Return value: null | string
@@ -151,7 +109,7 @@ public function getAbsoluteFileName(): string|null;
- #
getEntityDependencies
- | source code
+ | source code
```php
@@ -172,7 +130,7 @@ public function getEntityDependencies(): array;
- #
getFileContent
- | source code
+ | source code
```php
@@ -186,29 +144,6 @@ public function getFileContent(): string;
Return value: string
-
-
-
-
-
-- #
- getFileName
- | source code
-
-
-```php
-// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
-
-public function getFileName(): string|null;
-```
-
-Returns the relative path to a file if it can be retrieved and if the file is in the project directory
-
-Parameters: not specified
-
-Return value: string | null
-
-
@@ -216,11 +151,11 @@ public function getFileName(): string|null;
- #
getFileSourceLink
- | source code
+ | source code
```php
-public function getFileSourceLink(bool $withLine = true): string|null;
+public function getFileSourceLink(bool $withLine = true): null|string;
```
@@ -244,7 +179,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
-Return value: string | null
+Return value: null | string
@@ -254,7 +189,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
- #
getName
- | source code
+ | source code
```php
@@ -263,7 +198,7 @@ public function getFileSourceLink(bool $withLine = true): string|null;
public function getName(): string;
```
-
+Full name of the entity
Parameters: not specified
@@ -277,7 +212,7 @@ public function getName(): string;
- #
getObjectId
- | source code
+ | source code
```php
@@ -286,7 +221,7 @@ public function getName(): string;
public function getObjectId(): string;
```
-
+Entity object ID
Parameters: not specified
@@ -297,10 +232,39 @@ public function getObjectId(): string;
+
+- #
+ getRelativeFileName
+ | source code
+
+
+```php
+// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
+
+public function getRelativeFileName(): null|string;
+```
+
+File name relative to project_root configuration parameter
+
+Parameters: not specified
+
+Return value: null | string
+
+
+
+See:
+
+
+
+
+
- #
getRootEntityCollection
- | source code
+ | source code
```php
@@ -323,7 +287,7 @@ public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\Root
- #
getShortName
- | source code
+ | source code
```php
@@ -332,13 +296,57 @@ public function getRootEntityCollection(): \BumbleDocGen\Core\Parser\Entity\Root
public function getShortName(): string;
```
-
+Short name of the entity
Parameters: not specified
Return value: string
+
+
+
+
+
+- #
+ isEntityCacheOutdated
+ :warning: Is internal | source code
+
+
+```php
+// Implemented in BumbleDocGen\Core\Parser\Entity\EntityInterface
+
+public function isEntityCacheOutdated(): bool;
+```
+
+
+
+Parameters: not specified
+
+Return value: bool
+
+
+
+
+
+
+
+- #
+ isEntityDataCanBeLoaded
+ | source code
+
+
+```php
+public function isEntityDataCanBeLoaded(): bool;
+```
+
+Checking if it is possible to get the entity data
+
+Parameters: not specified
+
+Return value: bool
+
+
@@ -346,7 +354,7 @@ public function getShortName(): string;
- #
isEntityNameValid
- | source code
+ | source code
```php
@@ -384,7 +392,7 @@ public static function isEntityNameValid(string $entityName): bool;
- #
isExternalLibraryEntity
- | source code
+ | source code
```php
@@ -405,7 +413,7 @@ public function isExternalLibraryEntity(): bool;
- #
isInGit
- | source code
+ | source code
```php
@@ -421,5 +429,41 @@ public function isInGit(): bool;
+
-
\ No newline at end of file
+
+- #
+ normalizeClassName
+ | source code
+
+
+```php
+public static function normalizeClassName(string $name): string;
+```
+
+
+
+Parameters:
+
+
+
+
+ Name
+ Type
+ Description
+
+
+
+
+ $name
+ string
+ -
+
+
+
+
+Return value: string
+
+
+
+
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md b/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md
new file mode 100644
index 00000000..278c0591
--- /dev/null
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/frontMatter.md
@@ -0,0 +1,30 @@
+
+
+
+
+Front Matter is a special block at the top of a document template or generated document that contains certain important meta information.
+
+This block must be located strictly at the top of the template, its beginning and end are indicated by a combination of symbols `---`:
+
+```twig
+---
+title: Front Matter
+prevPage: How to create documentation templates?
+someVariable: 123
+---
+
+some template content ...
+```
+
+The content of this block must be in YAML format.
+During the template generation process, this block is parsed, and all values become available in the form of twig variables.
+By default, this block is hidden from generated MD files, but it can be displayed by enabling the special option render_with_front_matter in the configuration
+
+Some Front Matter block variables are used internally in our system, for example `title` and `prevPage` are used to generate breadcrumbs and documentation menus.
+
+This block is also used when generating HTML documentation. You can learn about the variables used in this block when generating HTML content [in the documentation of the library](https://daux.io/Features/Front_Matter.html) that we use to create HTML pages.
+
+
+
+
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/01_templates.md b/docs/tech/03_renderer/01_howToCreateTemplates/readme.md
similarity index 73%
rename from docs/tech/3.renderer/01_templates.md
rename to docs/tech/03_renderer/01_howToCreateTemplates/readme.md
index 72ce1bb5..95f8c7c0 100644
--- a/docs/tech/3.renderer/01_templates.md
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/readme.md
@@ -1,4 +1,4 @@
-
+
@@ -6,7 +6,7 @@ Templates are `twig` files in which you can write both static text and dynamic b
**You can read more about template parts here:**
-
+
@@ -23,15 +23,17 @@ After generating the documentation, this page will look exactly like a template.
```twig
- {% set title = 'Some page' %}
- {% set prevPage = 'Technical description of the project' %}
+ ---
+ title: Some page
+ prevPage: Technical description of the project
+ ---
{{ generatePageBreadcrumbs(title, _self) }}
Some static text...
Dynamic block:
- {{ printEntityCollectionAsList(phpClassEntityCollection.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
+ {{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
More static text...
@@ -72,9 +74,9 @@ Output method description as a dynamic block:
Dynamic block:
- {{ phpClassEntityCollection
+ {{ phpEntities
.get('\\BumbleDocGen\\LanguageHandler\\LanguageHandlerInterface')
- .getMethodEntity('getLanguageKey')
+ .getMethod('getLanguageKey')
.getDescription()
}}
@@ -101,4 +103,4 @@ Result after starting the documentation generation process:
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Jan 11 00:14:41 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md b/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md
new file mode 100644
index 00000000..2af0eedd
--- /dev/null
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/templatesDynamicBlocks.md
@@ -0,0 +1,29 @@
+
+
+
+
+There are several ways to create dynamic blocks in templates.
+
+* First of all, these are custom twig functions and filters.
+You can use the built-in functions and filters or add your own, so you can implement any logic for generating dynamically changing content.
+
+```twig
+ {{ printEntityCollectionAsList(phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable()) }}
+```
+
+
+* The second way is to output data from variables directly to the template. For example, you can display a list of classes or methods of documented code according to certain rules.
+
+```twig
+ {% for entity in phpEntities.filterByInterfaces(['\\BumbleDocGen\\Core\\Parser\\SourceLocator\\SourceLocatorInterface']).getOnlyInstantiable() %}
+ * {{ entity.getName() }}
+ {% endfor %}
+
+```
+
+
+
+
+
+
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Jan 11 00:14:41 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md b/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md
new file mode 100644
index 00000000..70c54f40
--- /dev/null
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/templatesLinking.md
@@ -0,0 +1,41 @@
+
+
+
+
+One of the main requirements of the documentation is to be able to easily and quickly implement linking between pages.
+We have several options for this, such as using special functions or using a special document linking mechanism (`completing blank links`)
+
+
+
+Plugin PageHtmlLinkerPlugin have been added to the basic configuration,
+which process the text of the filled template before its result is written to a file, and fill in all empty links.
+
+For example, an empty link:
+
+<a>Existent page name</a>
+
+will be replaced with this link:
+
+<a href="/docs/some/page/targetPage.md">Existent page name</a>
+
+Sometimes the use of standard empty links is not entirely obvious or has insufficient capabilities. For example, in standard empty links it is not obvious which link text will be used in the end.
+
+To fix this, we implemented a special mechanism with link tags: [a][/a]
+
+Examples:
+
+[a]Existent page name[/a] => <a href="/docs/some/page/targetPage.md">Existent page name</a>
+
+[a x-title="test"]Existent page name[/a] => <a href="/docs/some/page/targetPage.md">test</a>
+
+
+
+
+The second way to relink templates is to generate links through functions.
+
+There are a number of functions that allow you to get a link to an entity, for example GetDocumentedEntityUrl, and there are also functions for getting a link to other documents, for example GetDocumentationPageUrl.
+You can also implement your own functions for relinking if necessary.
+
+
+
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 01:40:01 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md b/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md
new file mode 100644
index 00000000..b409bc19
--- /dev/null
+++ b/docs/tech/03_renderer/01_howToCreateTemplates/templatesVariables.md
@@ -0,0 +1,16 @@
+
+
+
+
+There are several variables available in each processed template.
+
+1) Firstly, these are built-in twig variables, for example `_self`, which returns the path to the processed template.
+
+2) Secondly, variables with collections of processed programming languages are available in the template (see LanguageHandlerInterface). For example, when processing a PHP project collection, a collection PhpEntitiesCollection will be available in the template under the name phpEntities
+
+3) Thirdly, all variables specified in **Front Matter** are automatically converted into template variables and are available in it
+
+
+
+
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/02_breadcrumbs.md b/docs/tech/03_renderer/02_breadcrumbs.md
similarity index 70%
rename from docs/tech/3.renderer/02_breadcrumbs.md
rename to docs/tech/03_renderer/02_breadcrumbs.md
index 38a39bce..4af6af8e 100644
--- a/docs/tech/3.renderer/02_breadcrumbs.md
+++ b/docs/tech/03_renderer/02_breadcrumbs.md
@@ -1,8 +1,8 @@
-
+
-To work with breadcrumbs and get the structure of the documentation, we use the inner class BreadcrumbsHelper.
+To work with breadcrumbs and get the structure of the documentation, we use the inner class BreadcrumbsHelper.
To build the documentation structure, twig templates from the `templates_dir` configuration are used.
@@ -13,10 +13,12 @@ For each directory there is an index file ( readme.md or index.md
But in addition to building the documentation structure using the actual location of template files in directories,
-you can explicitly specify the parent page in each template using the special variable `prevPage`:
+you can explicitly specify the parent page in each template using the special front matter variable `prevPage`:
-```twig
- {% set prevPage = 'Prev page name' %}
+```markdown
+ ---
+ prevPage: Prev page name
+ ---
```
@@ -26,7 +28,7 @@ In this way, complex documentation structures can be created with less file nest
-There is a built-in function to generate breadcrumbs in templates GeneratePageBreadcrumbs.
+There is a built-in function to generate breadcrumbs in templates GeneratePageBreadcrumbs.
Here is how it is used in twig templates:
```twig
@@ -35,20 +37,22 @@ Here is how it is used in twig templates:
To build breadcrumbs, the previously compiled project structure and the names of each template are used.
-The template name can be specified using the `title` variable:
+The template name can be specified using the `title` front matter variable:
-```twig
- {% set title = 'Some page title' %}
+```markdown
+ ---
+ title: Some page title
+ ---
```
Here is an example of the result of the `generatePageBreadcrumbs` function:
```twig
-
+
```
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/03_documentStructure.md b/docs/tech/03_renderer/03_documentStructure.md
similarity index 79%
rename from docs/tech/3.renderer/03_documentStructure.md
rename to docs/tech/03_renderer/03_documentStructure.md
index f7a420ff..b8d84d88 100644
--- a/docs/tech/3.renderer/03_documentStructure.md
+++ b/docs/tech/03_renderer/03_documentStructure.md
@@ -1,4 +1,4 @@
-
+
@@ -19,4 +19,4 @@ plugins:
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/04_twigCustomFilters.md b/docs/tech/03_renderer/04_twigCustomFilters.md
similarity index 74%
rename from docs/tech/3.renderer/04_twigCustomFilters.md
rename to docs/tech/03_renderer/04_twigCustomFilters.md
index cb110aaa..84d544ee 100644
--- a/docs/tech/3.renderer/04_twigCustomFilters.md
+++ b/docs/tech/03_renderer/04_twigCustomFilters.md
@@ -1,9 +1,9 @@
-
+
When generating pages, you can use filters that allow you to modify the content.
-Filters available during page generation are defined in the configuration ( `twig_filters` parameter )
+Filters available during page generation are defined in the configuration ( `twig_filters` parameter )
We use the twig template engine, you can get more information about working with filters here: https://twig.symfony.com/doc/1.x/advanced.html#filters
@@ -28,7 +28,7 @@ twig_filters:
```
It is important to remember that when a template is inherited, custom filters are not overridden and augmented.
-This information is detailed on page Configuration files.
+This information is detailed on page Configuration.
@@ -55,9 +55,8 @@ Here is a list of filters available by default:
- addIndentFromLeft
- Filter adds indent from left
-
+ addIndentFromLeft
+ Filter adds indent from left
- fixStrSize
- The filter pads the string with the specified characters on the right to the specified size
-
+ fixStrSize
+ The filter pads the string with the specified characters on the right to the specified size
- preg_match
- Perform a regular expression match
-
+ implode
+ Join array elements with a string
+
+
+
+
+
+ $separator
+
+
+ string
+
+ Element separator in result string
+
+
+
+
+
+
+ preg_match
+ Perform a regular expression match
- prepareSourceLink
- The filter converts the string into an anchor that can be used in a GitHub document link
-
+ prepareSourceLink
+ The filter converts the string into an anchor that can be used in a GitHub document link
The filter does not accept any additional parameters
@@ -152,9 +168,8 @@ Here is a list of filters available by default:
- quotemeta
- Quote meta characters
-
+ quotemeta
+ Quote meta characters
The filter does not accept any additional parameters
@@ -162,9 +177,8 @@ Here is a list of filters available by default:
- removeLineBrakes
- The filter replaces all line breaks with a space
-
+ removeLineBrakes
+ The filter replaces all line breaks with a space
The filter does not accept any additional parameters
@@ -172,9 +186,8 @@ Here is a list of filters available by default:
- strTypeToUrl
- The filter converts the string with the data type into a link to the documented entity, if possible.
-
:warning: This filter initiates the creation of documents for the displayed entities
+ strTypeToUrl
+ The filter converts the string with the data type into a link to the documented entity, if possible.
:warning: This filter initiates the creation of documents for the displayed entities
- textToCodeBlock
- Convert text to code block
-
+ textToCodeBlock
+ Convert text to code block
- textToHeading
- Convert text to html header
-
+ textToHeading
+ Convert text to html header
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/3.renderer/05_twigCustomFunctions.md b/docs/tech/03_renderer/05_twigCustomFunctions.md
similarity index 83%
rename from docs/tech/3.renderer/05_twigCustomFunctions.md
rename to docs/tech/03_renderer/05_twigCustomFunctions.md
index 9a0db2a5..b3449148 100644
--- a/docs/tech/3.renderer/05_twigCustomFunctions.md
+++ b/docs/tech/03_renderer/05_twigCustomFunctions.md
@@ -1,14 +1,14 @@
-
+
When generating pages, you can use functions that allow you to modify the content.
-Functions available during page generation are defined in the configuration ( `twig_functions` parameter )
+Functions available during page generation are defined in the configuration ( `twig_functions` parameter )
We use the twig template engine, you can get more information about working with functions here: https://twig.symfony.com/doc/1.x/advanced.html#functions
You can also create your own functions and use them for any purpose, such as loading some additional information into a template, filtering data, or formatting the output of any information.
-Each function must implement the CustomFunctionInterface interface, implement the `__invoke` magic method, and be added to the configuration.
+Each function must implement the CustomFunctionInterface interface, implement the `__invoke` magic method, and be added to the configuration.
@@ -26,7 +26,7 @@ twig_functions:
```
It is important to remember that when a template is inherited, custom functions are not overridden and augmented.
-This information is detailed on page Configuration files.
+This information is detailed on page Configuration.
@@ -53,7 +53,7 @@ Here is a list of functions available by default:
- drawDocumentationMenu
+ drawDocumentationMenu
Generate documentation menu in HTML format. To generate the menu, the start page is taken, and all links with this page are recursively collected for it, after which the html menu is created.
:warning: This function initiates the creation of documents for the displayed entities
@@ -81,14 +81,14 @@ Here is a list of functions available by default:
- drawDocumentedEntityLink
+ drawDocumentedEntityLink
Creates an entity link by object
:warning: This function initiates the creation of documents for the displayed entities
$entity
- RootEntityInterface
+ RootEntityInterface
The entity for which we want to get the link
@@ -121,7 +121,7 @@ Here is a list of functions available by default:
- fileGetContents
+ fileGetContents
Displaying the content of a file or web resource
@@ -137,7 +137,7 @@ Here is a list of functions available by default:
- generatePageBreadcrumbs
+ generatePageBreadcrumbs
Function to generate breadcrumbs on the page
@@ -177,7 +177,7 @@ Here is a list of functions available by default:
- getDocumentationPageUrl
+ getDocumentationPageUrl
Creates an entity link by object
@@ -193,14 +193,14 @@ Here is a list of functions available by default:
- getDocumentedEntityUrl
+ getDocumentedEntityUrl
Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called, the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
:warning: This function initiates the creation of documents for the displayed entities
$rootEntityCollection
- RootEntityCollection
+ RootEntityCollection
Processed entity collection
@@ -245,7 +245,7 @@ Here is a list of functions available by default:
- loadPluginsContent
+ loadPluginsContent
:warning: For internal use
Process entity template blocks with plugins. The method returns the content processed by plugins.
@@ -264,7 +264,7 @@ Here is a list of functions available by default:
$entity
- RootEntityInterface
+ RootEntityInterface
The entity for which we process the content block
@@ -285,14 +285,14 @@ Here is a list of functions available by default:
- printEntityCollectionAsList
+ printEntityCollectionAsList
Outputting entity data as HTML list
:warning: This function initiates the creation of documents for the displayed entities
$rootEntityCollection
- RootEntityCollection
+ RootEntityCollection
Processed entity collection
@@ -337,14 +337,30 @@ Here is a list of functions available by default:
- drawClassMap
+ displayClassApiMethods
+ Display all API methods of a class
+
+
+ $className
+
+
+ string
+
+ Name of the class for which API methods need to be displayed
+
+
+
+
+
+
+ drawClassMap
Generate class map in HTML format
:warning: This function initiates the creation of documents for the displayed entities
- $classEntityCollections
+ $entitiesCollections
- ClassEntityCollection
+ PhpEntitiesCollection
The collection of entities for which the class map will be generated
@@ -353,7 +369,7 @@ Here is a list of functions available by default:
- getClassMethodsBodyCode
+ getClassMethodsBodyCode
Get the code of the specified class methods as a formatted string
@@ -385,4 +401,4 @@ Here is a list of functions available by default:
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
\ No newline at end of file
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
\ No newline at end of file
diff --git a/docs/tech/1.configuration/classes/AddIndentFromLeft.md b/docs/tech/03_renderer/classes/AddIndentFromLeft.md
similarity index 94%
rename from docs/tech/1.configuration/classes/AddIndentFromLeft.md
rename to docs/tech/03_renderer/classes/AddIndentFromLeft.md
index 2e433da2..18504932 100644
--- a/docs/tech/1.configuration/classes/AddIndentFromLeft.md
+++ b/docs/tech/03_renderer/classes/AddIndentFromLeft.md
@@ -1,5 +1,4 @@
-
-
+
AddIndentFromLeft class:
@@ -149,5 +148,3 @@ public static function getOptions(): array;
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md b/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
similarity index 77%
rename from docs/tech/3.renderer/classes/BreadcrumbsHelper.md
rename to docs/tech/03_renderer/classes/BreadcrumbsHelper.md
index 3559f4cc..534edc34 100644
--- a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md
+++ b/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
@@ -1,8 +1,7 @@
-
-
+
- BreadcrumbsHelper class:
+ BreadcrumbsHelper class:
@@ -54,6 +53,9 @@ final class BreadcrumbsHelper
getPageLinkByKey
+
+ getTemplateFrontMatter
+
getTemplateLinkKey
@@ -70,7 +72,7 @@ final class BreadcrumbsHelper
- #
-
DEFAULT_PREV_PAGE_NAME_TEMPLATE | source
+ DEFAULT_PREV_PAGE_NAME_TEMPLATE | source
code
@@ -85,7 +87,7 @@ final class BreadcrumbsHelper
- #
__construct
- | source code
+ | source code
```php
@@ -142,7 +144,7 @@ public function __construct(\BumbleDocGen\Core\Configuration\Configuration $conf
- #
getAllPageLinks
- | source code
+ | source code
```php
@@ -165,7 +167,7 @@ public function getAllPageLinks(): array;
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+ \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
@@ -176,7 +178,7 @@ public function getAllPageLinks(): array;
- #
getBreadcrumbs
- | source code
+ | source code
```php
@@ -221,7 +223,7 @@ public function getBreadcrumbs(string $filePatch, bool $fromCurrent = true): arr
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+ \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
@@ -232,7 +234,7 @@ public function getBreadcrumbs(string $filePatch, bool $fromCurrent = true): arr
- #
getBreadcrumbsForTemplates
- | source code
+ | source code
```php
@@ -277,7 +279,7 @@ public function getBreadcrumbsForTemplates(string $filePatch, bool $fromCurrent
\DI\DependencyException
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+ \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
@@ -288,7 +290,7 @@ public function getBreadcrumbsForTemplates(string $filePatch, bool $fromCurrent
- #
getNearestIndexFile
- | source code
+ | source code
```php
@@ -322,7 +324,7 @@ public function getNearestIndexFile(string $templateName): string;
Throws:
-
- \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
+ \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
@@ -333,11 +335,11 @@ public function getNearestIndexFile(string $templateName): string;
- #
getPageDataByKey
- | source code
+ | source code
```php
-public function getPageDataByKey(string $key): array|null;
+public function getPageDataByKey(string $key): null|array;
```
@@ -361,7 +363,7 @@ public function getPageDataByKey(string $key): array|null;
-Return value: array | null
+Return value: null | array
Throws:
@@ -370,7 +372,7 @@ public function getPageDataByKey(string $key): array|null;
\DI\DependencyException
-
-
- # - entityCacheIsOutdated - | source code -
-
-
- # - entityDataCanBeLoaded - | source code -
Checking if it is possible to get the entity data- -Parameters: not specified - -Return value: bool - - -
- # getAbsoluteFileName - | source code + | source code
Returns the absolute path to a file if it can be retrieved and if the file is in the project directoryParameters: not specified -Return value: string | null +Return value: null | string
-
-
- # - getFileName - | source code -
Returns the relative path to a file if it can be retrieved and if the file is in the project directory- -Parameters: not specified - -Return value: string | null - -
- # getFileSourceLink - | source code + | source code
-
+
- # + getRelativeFileName + | source code +
File name relative to project_root configuration parameter+ +Parameters: not specified + +Return value: null | string + + + +See: + +
- # getRootEntityCollection - | source code + | source code
- # getShortName - | source code + | source code
Short name of the entityParameters: not specified Return value: string +
-
+
- # + isEntityCacheOutdated + :warning: Is internal | source code +
-
+
- # + isEntityDataCanBeLoaded + | source code +
Checking if it is possible to get the entity data+ +Parameters: not specified + +Return value: bool + +
- # isEntityNameValid - | source code + | source code
- # isExternalLibraryEntity - | source code + | source code
- # isInGit - | source code + | source code
-
+
- # + normalizeClassName + | source code +
| Name | +Type | +Description | +
|---|---|---|
| $name | +string | +- | +
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Jan 11 00:14:41 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 01:40:01 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
+Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Jan 12 18:53:16 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Fri Oct 13 18:40:45 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
- Filter adds indent from left -
+ Filter adds indent from left
- The filter pads the string with the specified characters on the right to the specified size -
+ The filter pads the string with the specified characters on the right to the specified size
- Perform a regular expression match -
+ Join array elements with a string +
+ Perform a regular expression match
- The filter converts the string into an anchor that can be used in a GitHub document link -
+ The filter converts the string into an anchor that can be used in a GitHub document link
- Quote meta characters -
+ Quote meta characters
- The filter replaces all line breaks with a space -
+ The filter replaces all line breaks with a space
- The filter converts the string with the data type into a link to the documented entity, if possible. -
:warning: This filter initiates the creation of documents for the displayed entities
+ The filter converts the string with the data type into a link to the documented entity, if possible.
:warning: This filter initiates the creation of documents for the displayed entities
- Convert text to code block -
+ Convert text to code block
- Convert text to html header -
+ Convert text to html header
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/3.renderer/05_twigCustomFunctions.md b/docs/tech/03_renderer/05_twigCustomFunctions.md similarity index 83% rename from docs/tech/3.renderer/05_twigCustomFunctions.md rename to docs/tech/03_renderer/05_twigCustomFunctions.md index 9a0db2a5..b3449148 100644 --- a/docs/tech/3.renderer/05_twigCustomFunctions.md +++ b/docs/tech/03_renderer/05_twigCustomFunctions.md @@ -1,14 +1,14 @@ - + When generating pages, you can use functions that allow you to modify the content. -Functions available during page generation are defined in the configuration ( `twig_functions` parameter ) +Functions available during page generation are defined in the configuration ( `twig_functions` parameter ) We use the twig template engine, you can get more information about working with functions here: https://twig.symfony.com/doc/1.x/advanced.html#functions You can also create your own functions and use them for any purpose, such as loading some additional information into a template, filtering data, or formatting the output of any information. -Each function must implement the CustomFunctionInterface interface, implement the `__invoke` magic method, and be added to the configuration. +Each function must implement the CustomFunctionInterface interface, implement the `__invoke` magic method, and be added to the configuration. @@ -26,7 +26,7 @@ twig_functions: ``` It is important to remember that when a template is inherited, custom functions are not overridden and augmented. -This information is detailed on page Configuration files. +This information is detailed on page Configuration. @@ -53,7 +53,7 @@ Here is a list of functions available by default:
+ drawDocumentationMenu
Generate documentation menu in HTML format. To generate the menu, the start page is taken, and all links with this page are recursively collected for it, after which the html menu is created.
:warning: This function initiates the creation of documents for the displayed entities
+ drawDocumentedEntityLink
Creates an entity link by object
:warning: This function initiates the creation of documents for the displayed entities
+ fileGetContents
Displaying the content of a file or web resource
+ generatePageBreadcrumbs
Function to generate breadcrumbs on the page
+ getDocumentationPageUrl
Creates an entity link by object
+ getDocumentedEntityUrl
Get the URL of a documented entity by its name. If the entity is found, next to the file where this method was called, the `EntityDocRendererInterface::getDocFileExtension()` directory will be created, in which the documented entity file will be created
:warning: This function initiates the creation of documents for the displayed entities
+ loadPluginsContent
:warning: For internal use
Process entity template blocks with plugins. The method returns the content processed by plugins.
+ printEntityCollectionAsList
Outputting entity data as HTML list
:warning: This function initiates the creation of documents for the displayed entities
+ displayClassApiMethods
+ Display all API methods of a class +
Generate class map in HTML format
:warning: This function initiates the creation of documents for the displayed entities
+ getClassMethodsBodyCode
Get the code of the specified class methods as a formatted string
-Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator
Last modified date: Wed Jan 10 23:55:33 2024 +0300
Page content update date: Mon Jan 15 2024
Made with Bumble Documentation Generator \ No newline at end of file diff --git a/docs/tech/1.configuration/classes/AddIndentFromLeft.md b/docs/tech/03_renderer/classes/AddIndentFromLeft.md similarity index 94% rename from docs/tech/1.configuration/classes/AddIndentFromLeft.md rename to docs/tech/03_renderer/classes/AddIndentFromLeft.md index 2e433da2..18504932 100644 --- a/docs/tech/1.configuration/classes/AddIndentFromLeft.md +++ b/docs/tech/03_renderer/classes/AddIndentFromLeft.md @@ -1,5 +1,4 @@ - - +
AddIndentFromLeft class:
@@ -149,5 +148,3 @@ public static function getOptions(): array;
-
-
\ No newline at end of file
diff --git a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md b/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
similarity index 77%
rename from docs/tech/3.renderer/classes/BreadcrumbsHelper.md
rename to docs/tech/03_renderer/classes/BreadcrumbsHelper.md
index 3559f4cc..534edc34 100644
--- a/docs/tech/3.renderer/classes/BreadcrumbsHelper.md
+++ b/docs/tech/03_renderer/classes/BreadcrumbsHelper.md
@@ -1,8 +1,7 @@
-
-
+
- BreadcrumbsHelper class:
+ BreadcrumbsHelper class:
@@ -54,6 +53,9 @@ final class BreadcrumbsHelper
- #
-
DEFAULT_PREV_PAGE_NAME_TEMPLATE| source +DEFAULT_PREV_PAGE_NAME_TEMPLATE| source code
- # __construct - | source code + | source code
- # getAllPageLinks - | source code + | source code
- # getBreadcrumbs - | source code + | source code
- # getBreadcrumbsForTemplates - | source code + | source code
- # getNearestIndexFile - | source code + | source code
- - \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException + \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
- # getPageDataByKey - | source code + | source code
+
+2) To track exactly how documentation is generated, you can use the interactive mode:
+
+ `vendor/bin/bumbleDocGen serve` - So that the generated documentation changes automatically with changes in templates
+
+ **or**
+
+ `vendor/bin/bumbleDocGen serve --as-html` - So that the generated documentation changes automatically with changes in templates and is displayed as HTML on the local development server
+3) Logs are saved to a special file `last_run.log` which is located in the working directory
+
+
+