PHP download

Download the PHP package bumble-tech/bumble-doc-gen without Composer

On this page you can find all versions of the php package bumble-tech/bumble-doc-gen. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download bumble-tech/bumble-doc-gen
More information about bumble-tech/bumble-doc-gen
Files in bumble-tech/bumble-doc-gen

Vendor bumble-tech
Package bumble-doc-gen
Short Description Documentation generator next to the code for large and small php projects
License Apache-2.0
Homepage https://github.com/bumble-tech/bumble-doc-gen

Keywords documentation phpdoc php docs cli-tool documentation-generator ChatGpt llms

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of bumble-tech/bumble-doc-gen

Informations about the package bumble-doc-gen

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

Add the BumbleDocGen to the composer.json file of your project using the following command:

Detailed technical description

💡 Please refer to the Description of the technical part of the project for a detailed explanation of all the classes and methods used.

Core Features

🔍 Parsing: BumbleDocGen scans your project by parsing PHP files, extracting comments, and providing detailed models of your code.
✍️ Rendering: 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

Entry points

BumbleDocGen's interface consists of mainly two classes: DocGeneratorFactory.

DocGenerator 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 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

1) Working with a library in a PHP file

2) Working with the library through a console application

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:

Last page committer: fshcherbanich <[email protected]>
Last modified date: Sat Oct 28 11:03:31 2023 +0300
Page content update date: Mon Nov 06 2023
Made with Bumble Documentation Generator

All versions of bumble-doc-gen with dependencies

PHP Build Version

Package Version

Version v1.6.0 Release 05. Dec 2023
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of bumble-doc-gen from vendor bumble-tech

Requires php Version ^8.0.0
ext-zlib Version *
ext-mbstring Version *
symfony/console Version ^6.0
symfony/finder Version ^6.0
twig/twig Version ^3.3
roave/better-reflection Version ^5.5
nikic/php-parser Version ^4.13
phpdocumentor/reflection-docblock Version ^5.3
doctrine/annotations Version ^1.13
nette/php-generator Version ^4.0
monolog/monolog Version ^2.5
bramus/monolog-colored-line-formatter Version ^3.0
symfony/cache Version ^6.0
symfony/event-dispatcher Version ^6.0
php-di/php-di Version ^7.0
symfony/yaml Version ^6.0
hassankhan/config Version ^3.1
guzzlehttp/guzzle Version ^7.8
symfony/filesystem Version ^6.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bumble-tech/bumble-doc-gen contains the following files

Loading the files please wait ....