Documentor¶
Overview¶
Documentor is an online tool to convert PHP class code first to HTML, and subsequently to Redmine Wiki format.
You can literally build skeleton documentation in 3 or 4 clicks.
The idea is to generate first-class stub code, then take it into something like Dreamweaver where it's much easier to complete expanded documentation, and finally convert to Redmine wiki format.
Options¶
It has a bunch of PHP options for:
- classes, methods & properties
- access modifiers
- visibility
The HTML is solid, and it can generate:
- multiple classes per file
- javadoc title, further comments, and optionally params
- method and property information and grouping
- sample code stubs
- additional semantic markup, including Kohana CSS, divs and anchors
The Redmine syntax generated includes:
- faithful conversion of 95% of the Redmine wiki format
- support for basic tables
- support for links same-page and inter-page links to wiki format, meaning decent cross-linking is now a snap
- general tidying up of the underlying markup resulting in tidy wiki formatting
Usage¶
I've tried to make it super easy, and there's sample code you can use to get you started.
Try copying and pasting some of the code Kohana classes in to see how it copes!
Get Started¶
Launch Documentor here:
https://keyframesandcode.com/resources/php/redmine/documentor/