readme.md

BumbleDocGen / Technical description of the project

---

Technical description of the project

This documentation generator is a library that allows you to create handwritten documentation with dynamic blocks that are loaded from the project code or other places.

Documentation sections

• Configuration files
• Parser
• Renderer
• Plugin system
• Class map

How it works

 graph TD;
    A(1. User wants to document the project)
    B(2. Creates and fills documentation configuration file)
    C(3. Creates templates for future documentation)
    D(4. Generates documentation based on templates)

    A --> B
    B --> C
    C --> D

    note1[Note: Documentation is placed next to the code according to settings]
    D --> note1

Loading

To start the documentation generation process, you need to call the following command:

 (new DocGeneratorFactory())->create($configFile)->generate()

or

 (new DocGeneratorFactory())->createByConfigArray($configArray)->generate()

After that, the process of parsing the project code according to the configuration will start, and then filling the templates with data and saving the finished result as final documents.

---

Last page committer: fshcherbanich <filipp.shcherbanich@team.bumble.com>
Last modified date: Thu Oct 5 17:42:06 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator