How to generate Yii like Documentation

How-tos

doc

Note that you have to use the full alias path 'application.modules.mymodule' and not only 'mymodule', thats becuase Yii Docs Generator does not instantiate any class so the path aliases for modules are never set.

### Documenting Views

If you want to annotatedocument your views, add a doc block right at the top of the view file with the file description. You can also specify the parameters that your view file receives by using the @uses tag, e.g. [ 
```php]

<?php
/*** @uses User $model The user model
*/
~~~```
 
 
If you don't want to document your views you can turn this behaviour off by adding the parameter noviews to the end of the shell command, e.g.
 
 
 
./yiic docs /path/to/your/docs/folder noviews
 
 
 
Thats it for now, the Yii Docs Generator is still a work in progress but as you can see its already a powerful too, that will get you some nice documentation and as you can see its pretty easy to use. The Yii Docs Generator also comes with a check command, that will help you check if there is some important missing documentation, but wont check things like @package of class documentation so its always good to check your files manually after using this command.