https://github.com/jbroadway/visor
API documentation generator for the Elefant CMS
https://github.com/jbroadway/visor
Last synced: 13 days ago
JSON representation
API documentation generator for the Elefant CMS
- Host: GitHub
- URL: https://github.com/jbroadway/visor
- Owner: jbroadway
- Created: 2012-05-14T18:20:51.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2021-09-28T00:44:17.000Z (over 3 years ago)
- Last Synced: 2025-04-09T21:52:23.009Z (13 days ago)
- Language: PHP
- Homepage: http://www.elefantcms.com/
- Size: 94.7 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a very simple documentation generator for the
[Elefant CMS](http://www.elefantcms.com/). 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