Download the PHP package zero-to-prod/docgen-visitor without Composer
On this page you can find all versions of the php package zero-to-prod/docgen-visitor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zero-to-prod/docgen-visitor
More information about zero-to-prod/docgen-visitor
Files in zero-to-prod/docgen-visitor
Package docgen-visitor
Short Description A PHP AST visitor for automatically generating or updating docblocks in PHP source code.
License MIT
Homepage https://github.com/zero-to-prod/docgen-visitor
Informations about the package docgen-visitor
Zerotoprod\DocgenVisitor
Contents
- Introduction
- Requirements
- Installation
- Documentation Publishing
- Automatic Documentation Publishing
- Usage
- Local Development
- Contributing
Introduction
A PHP AST visitor for automatically generating or updating docblocks in PHP source code.
Requirements
- PHP 7.1 or higher.
Installation
Install Zerotoprod\DocgenVisitor via Composer:
This will add the package to your project's dependencies and create an autoloader entry for it.
Documentation Publishing
You can publish this README to your local documentation directory.
This can be useful for providing documentation for AI agents.
This can be done using the included script:
Automatic Documentation Publishing
You can automatically publish documentation by adding the following to your composer.json:
Usage
Here's how you can use DocgenVisitor to read a PHP file, process its contents, and then write the updated code back to the same file:
Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit changes (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature-branch). - Create a new Pull Request.