PHPackages bumble-tech/bumble-doc-gen - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. bumble-tech/bumble-doc-gen ActiveLibrary[Utility & Helpers](/categories/utility) bumble-tech/bumble-doc-gen ========================== Documentation generator next to the code for large and small php projects v1.6.0(2y ago)94025[10 issues](https://github.com/bumble-tech/bumble-doc-gen/issues)[2 PRs](https://github.com/bumble-tech/bumble-doc-gen/pulls)Apache-2.0PHPPHP ^8.0.0 Since Sep 11Pushed 2y ago2 watchersCompare [ Source](https://github.com/bumble-tech/bumble-doc-gen)[ Packagist](https://packagist.org/packages/bumble-tech/bumble-doc-gen)[ Docs](https://github.com/bumble-tech/bumble-doc-gen)[ RSS](/packages/bumble-tech-bumble-doc-gen/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (8)Dependencies (22)Versions (15)Used By (0) BumbleDocGen: A Documentation Generator for PHP projects 🐝 ========================================================== [](#bumbledocgen-a-documentation-generator-for-php-projects-) **BumbleDocGen** is a robust library for generating and maintaining documentation next to the code of large and small PHP projects. This tool analyzes your codebase and produces a comprehensive set of Markdown documents, including descriptions of classes, methods, and properties alongside navigable internal links. Installation ------------ [](#installation) Add the BumbleDocGen to the `composer.json` file of your project using the following command: ``` composer require bumble-tech/bumble-doc-gen ``` Detailed technical description ------------------------------ [](#detailed-technical-description) 💡 Please refer to the [Description of the technical part of the project](/docs/tech/readme.md) for a detailed explanation of all the classes and methods used. Core Features ------------- [](#core-features) - 🔍 **[Parsing](/docs/tech/2.parser/readme.md):**BumbleDocGen scans your project by parsing PHP files, extracting comments, and providing detailed models of your code. - ✍️ **[Rendering](/docs/tech/3.renderer/readme.md):**BumbleDocGen generates markdown content using templates and fills them with data obtained from parsing your code. - 🧠 **AI tools for documentation generation:**BumbleDocGen allows you to use a group of AI tools to help generate project documentation. How to Use ---------- [](#how-to-use) ### Entry points [](#entry-points) BumbleDocGen's interface consists of mainly two classes: [DocGenerator](/docs/classes/DocGenerator.md) and [DocGeneratorFactory](/docs/classes/DocGeneratorFactory.md). - [DocGenerator](/docs/classes/DocGenerator.md) provides main operations for generating the documents. - `addMissingDocBlocks()`: This method creates missing docBlocks in your code. - `fillInReadmeMdTemplate()`: This method prepares the `README.md` file using a predefined template. - `generate()`: This method produces all necessary documentation. - `generateProjectTemplatesStructure()`: This method creates a structure for project templates. - `parseAndGetRootEntityCollectionsGroup()`: This method parses your project's files and collects information for the documentation. - [DocGeneratorFactory](/docs/classes/DocGeneratorFactory.md) provides a method for creating `DocGenerator` instance. - `create(configurationFiles: string)`: This method creates a `DocGenerator` instance using provided configuration files. - `setCustomConfigurationParameters(customConfigurationParameters: array)`: This method sets custom configuration parameters for the `DocGenerator` creation. ### Examples of usage [](#examples-of-usage) 1. Working with a library in a PHP file ``` require_once 'vendor/autoload.php'; use BumbleDocGen\DocGeneratorFactory; // Initialize the factory $factory = new DocGeneratorFactory(); // Create a DocGenerator instance $docgen = $factory->create('/path/to/configuration/files'); // or $docgen = $factory->createByConfigArray([...]); // Now call the desired operation $docgen->generate(); ``` 2. Working with the library through a console application ``` # List of available commands ./vendor/bin/bumbleDocGen list # Documentation generation example ./vendor/bin/bumbleDocGen generate -c # Getting detailed information about a command ./vendor/bin/bumbleDocGen generate -h ``` --- **This documentation was generated using the Bumble Documentation Generator, and is an example of how it works.** To update this documentation, run the following command: ``` ./bin/bumbleDocGen generate ``` --- **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](https://github.com/bumble-tech/bumble-doc-gen/blob/master/docs/README.md) ### Health Score 25 — LowBetter than 37% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity21 Limited adoption so far Community17 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 94.1% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~26 days Recently: every ~47 days Total 10 Last Release 732d ago Major Versions v1.6.0 → 2.x-dev2024-05-08 PHP version history (2 changes)v1.0.0PHP ^8.0.0 2.x-devPHP ^8.1.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/94ac0ec318be353da4f3451693838d0bd64c86cf8b3aa242d2314e574d169a39?d=identicon)[Seanmcn](/maintainers/Seanmcn) ![](https://www.gravatar.com/avatar/5b5b538dd6b74f71a541338284ecb23d74b3784328a2f8dc1cc7804cadc4f304?d=identicon)[shcherbanich](/maintainers/shcherbanich) --- Top Contributors [![shcherbanich](https://avatars.githubusercontent.com/u/3122336?v=4)](https://github.com/shcherbanich "shcherbanich (1320 commits)")[![seanmcn](https://avatars.githubusercontent.com/u/1639126?v=4)](https://github.com/seanmcn "seanmcn (71 commits)")[![misantron](https://avatars.githubusercontent.com/u/9839955?v=4)](https://github.com/misantron "misantron (8 commits)")[![NikolayAleshin](https://avatars.githubusercontent.com/u/23275554?v=4)](https://github.com/NikolayAleshin "NikolayAleshin (2 commits)")[![praem90](https://avatars.githubusercontent.com/u/6235720?v=4)](https://github.com/praem90 "praem90 (2 commits)") --- Tags chatgptcli-tooldocsdocumentationdocumentation-generatorhacktoberhacktoberfesthacktoberfest2023llmsphpphpdocphpphpdocdocumentationdocsChatGptllmsDocumentation generatorCLI Tool ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/bumble-tech-bumble-doc-gen/health.svg) ``` [![Health](https://phpackages.com/badges/bumble-tech-bumble-doc-gen/health.svg)](https://phpackages.com/packages/bumble-tech-bumble-doc-gen) ``` ### Alternatives [shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[silverstripe/framework The SilverStripe framework 7213.5M2.5k](/packages/silverstripe-framework)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M648](/packages/sylius-sylius)[phpdocumentor/phpdocumentor Documentation Generator for PHP 4.4k3.1M874](/packages/phpdocumentor-phpdocumentor) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)