chrisroy87 / php-docula

A simple and light weight API Usage & Developer Document generator for PHP

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docula

A simple and light weight API & Developer document generator for PHP applications. Now generate the API Usage Documentation along with developer documentation. This supports custom themes, manual text interventions, editing and cool graphical presentations. Targeted at real world API documentation needs and not limited to developer documentation like the most of the other applications.

Why Docula?

All the other documentation generators go through your individual files and create documenation based on the docBlock style comments. This is great. It does generate usable and sometimes, good looking documenations. The only caveat is that these are always talking about developer documentation in terms of classes and methods.

When generating documenation, it is of essence that the true usability be glorified via API Usage documents. Now, Docula combines both and gives you traditional docBlock developer documentation and also API Usage documentation - all in one static site with search features and HTML5 compliance. And you can also use your own themes.

About

A simple and light weight API Usage & Developer Document generator for PHP

License:MIT License