You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Makarov
a7a1bd8da0
|
11 years ago | |
|---|---|---|
| .. | ||
| commands | 11 years ago | |
| helpers | 11 years ago | |
| models | 11 years ago | |
| templates | 11 years ago | |
| .gitignore | 11 years ago | |
| CHANGELOG.md | 11 years ago | |
| LICENSE.md | 11 years ago | |
| README.md | 11 years ago | |
| apidoc | 11 years ago | |
| apidoc.bat | 11 years ago | |
| composer.json | 11 years ago | |
README.md
API documentation generator for Yii 2
This extension provides an API documentation generator for the Yii framework 2.0.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist yiisoft/yii2-apidoc "*"
or add
"yiisoft/yii2-apidoc": "*"
to the require section of your composer.json.
Usage
To generate API documentation, run the apidoc command.
vendor/bin/apidoc source/directory ./output
By default the offline template will be used. You can choose a different templates with the --template=name parameter.
Currently there is only the offline template available.
You may also add the yii\apidoc\commands\RenderController to your console application class map and
run it inside of your applications console app.
Creating your own templates
TDB
Using the model layer
TDB