Error202
/
yii2-swiftmailer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
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.
4419 Commits
1 Branch
15 Tags
11 MiB
 
 
Tree: c98d1fb9a6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c98d1fb9a6'
${ noResults }
yii2-swiftmailer/extensions/yii/apidoc
Alexander Makarov dc45de127c
Added --prefer-dist to all docs 		11 years ago
..
commands minor fixes to api doc template 11 years ago
helpers final cleanup apidoc generator 11 years ago
models final cleanup apidoc generator 11 years ago
templates minor fixes to api doc template 11 years ago
.gitignore renamed phpdoc extension to apidoc 11 years ago
CHANGELOG.md renamed phpdoc extension to apidoc 11 years ago
LICENSE.md renamed phpdoc extension to apidoc 11 years ago
README.md Added --prefer-dist to all docs 11 years ago
apidoc restructured apidoc templates 11 years ago
apidoc.bat finished render command, added cli script 11 years ago
composer.json finished render command, added cli script 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