Visor is an API documentation browser for the Elefant CMS
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:
To make the routes work well, add these to the
[Alias] section in
/api = /visor /helpers = /visor/helpers /helper = /visor/helper