Commit 82f7937a by Carsten Brandt

readme for apidoc

parent 5ede58fe
...@@ -25,7 +25,17 @@ to the require section of your composer.json. ...@@ -25,7 +25,17 @@ to the require section of your composer.json.
Usage Usage
----- -----
TDB 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 Creating your own templates
--------------------------- ---------------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment