rajudev/laravel-doc-generator

A Laravel package for generating documentation from controller comments.

v2.0.0 2025-01-22 11:34 UTC

Requires

• php: >=8.0
• illuminate/support: ^9.0|^10.0

Requires (Dev)

• orchestra/testbench: ^8.31
• phpunit/phpunit: ^9.5

MIT

• Raju-dev

README

This package generates documentation for Laravel controllers based on specially formatted comments.

Installation

composer require raju/laravel-doc-generator

Usage

Run the following Artisan command to generate documentation:

php artisan doc:generate

The generated documentation will be saved as storage/docs.json.

Markup Format

Add comments like this in your controllers:

/* raju
Description: Fetches user data by ID.
Where Used: User profile API.
*/
public function getUserData($id)
{
    // Your logic here
}