Download the PHP package stevebauman/autodoc-facades without Composer
On this page you can find all versions of the php package stevebauman/autodoc-facades. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download stevebauman/autodoc-facades
More information about stevebauman/autodoc-facades
Files in stevebauman/autodoc-facades
Package autodoc-facades
Short Description Auto-generate PHP doc annotations for Laravel facades
License MIT
Homepage https://github.com/stevebauman
Informations about the package autodoc-facades
Autodoc Facades
A facade documenter for your Laravel application.
Autodoc Facades uses the official Laravel Facade Documenter to easily generate doc annotations for your application's Laravel facades inside your app
directory using the @see
annotation with a single command:
Before:
After:
Installation
Install via composer:
Usage
Inside the terminal:
Inside a Laravel command:
Getting started
To begin, your facades must contain an @see
annotation with the fully-qualified namespace.
It will not resolve short-name classnames of classes that were imported.
For example, this will not work:
If the underlying class forwards calls to another class, add a @mixin
annotation to the underlying class so it is picked up by the documenter:
Generating annotations in path
To generate doc annotations for all facades in your app
directory, supply "app" as the path:
All paths you provide that do not start with a directory separator will use the commands current working directory as the base path.
Generating annotations in many paths
Space separate paths to generate annotations for facades in those directories:
Generating annotations for specific facades
Specify "only" classes to generate annotations only for those given:
You may provide multiple "only" classes by space separating them.
Generating annotations for except specific facades
Specify "except" classes to generate annotations for all facades, except for those given:
You may provide multiple "except" classes by space separating them.
All versions of autodoc-facades with dependencies
illuminate/support Version ^8.0|^9.0|^10.0|^11.0
phpstan/phpdoc-parser Version ^1.28