Error202
/
yii2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Yii2 framework backup
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.
4948 Commits
8 Branches
66 Tags
82 MiB
 
 
 
 
 
Tree: f36ec8c9ca
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f36ec8c9ca'
${ noResults }
yii2/extensions/apidoc
Carsten Brandt 33b53fa55d
added apidoc template based on twitter bootstrap 		11 years ago
..
commands improved erorr handling in api doc controller 11 years ago
helpers fixed phpdoc command. 11 years ago
models created apidoc generator online template for yiiframework.com 11 years ago
templates added apidoc template based on twitter bootstrap 11 years ago
.gitignore psr-4 change. 11 years ago
CHANGELOG.md psr-4 change. 11 years ago
LICENSE.md psr-4 change. 11 years ago
README.md psr-4 change. 11 years ago
apidoc apidoc command: fixed vendor path 11 years ago
apidoc.bat psr-4 change. 11 years ago
composer.json added apidoc template based on twitter bootstrap 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