@jbnv You can use the Laravel-ide-helper package to generate docblocks for each model’s attributes.
Generating documentation for models
My biggest pet peeve with Laravel is that it structures things around functionality rather than conceptual entities. I'm using Laravel to develop data management centers that revolve around conceptual entities such as people, organizations, etc. So I'm constantly having to open several different files to work on a problem with one entity.
Furthermore, Laravel doesn't require models to explicitly define all of their properties. That means that you can't just open the model class and see all of the attributes of the entity, unless you do something manual like defining casts for all of the properties.
I'm looking for a tool that will help me build documentation for the conceptual entities in my application. It doesn't have to be fully-automatic. Even if I have to give it a list of each attribute, that's better than having a set of Markdown files that always have to be updated by hand.
I'm using Laravel 9.0 and PHP 8.1.
A search for "laravel documentation generator" lead me to several API-based documentation generators, which isn't really what I need, but at least that's a starting point. Composer isn't letting me install either Laravel API Documentation Generator or Laravel IDoc.
is there anything out there that meets my needs and is up to date?
(Bienvenu's three rules of documentation: Nobody writes it. Nobody reads it. When you need it, it doesn't exist.)
Please or to participate in this conversation.