elefant/app-visor

Visor is an API documentation browser for the Elefant CMS

Installs: 22

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 1

Forks: 0

Open Issues: 0

Type:elefant-app

1.0 2012-08-16 13:36 UTC

This package is auto-updated.

Last update: 2022-07-28 02:28:35 UTC


README

This is a very simple documentation generator for the Elefant CMS. It uses PHP's Reflection classes to produce JavaDoc-style output from Elefant's core classes.

This is not meant as a full replacement for phpDoc or ApiGen, but rather a simple solution that we can more easily integrate into our website.

I wrote this for a few reasons:

  • I don't like the "interactive" elements in the output of the new phpDoc
  • I kept running into issues with ApiGen's code generation, and their Texy markup is inferior to Markdown
  • I want a more human-friendly comment format than they both allow
  • Documentation generation is pretty easy and even fun with PHP's Reflection capabilities

For a live example of this app in use, visit:

http://api.elefantcms.com/

To make the routes work well, add these to the [Alias] section in conf/routes.php:

/api = /visor
/helpers = /visor/helpers
/helper = /visor/helper