Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
[Unmaintained] Official CakePHP API Generator Git Repository
PHP JavaScript
tree: eeb44e070f

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
Config
Console/Command
Controller
Lib
Locale
Model
Test
View
webroot
.gitignore
README.mdown

README.mdown

Api Generator

The Api Generator provides an easy to use always current documentation generation tool. Api documentation is generated using PHP's reflection API. A few simple database tables are used to keep class indexes and provide project search features. Api Generator supports PHPdoc format docblocks and allows you to use Markdown formatting in your documentation blocks.

Requirements:

  • PHP5 - Requires PHP5.2. If you are on PHP4 too bad, time to upgrade anyways.
  • CakePHP 1.x
    • The 0.3 tag and 0.3-branch are compatible with CakePHP 1.2
    • The v0.4 tag and the 1.3 branch are compatible with CakePHP 1.3
    • The master branch is compatible with CakePHP 2.0

Configuration + Installation

Please See the installation guide.

Reporting issues

If you have an issues with Api Generator please open a ticket on lighthouse http://cakephp.lighthouseapp.com/projects/42879-api-generator/overview

Contributing

If you'd like to contribute to ApiGenerator, you can do so by forking the repository and sending pull requests. You can also open tickets for features at the lighthouse

Something went wrong with that request. Please try again.