Documentation generator for Eerie packages.
No need to install. If you've installed Eerie you already have Docio.
docio package=/path/to/package [template=/path/to/template]
It will search recursively for files with extensions "io", "docio", "c" and "m" in the directories
then it'll extract documentation from it and compile HTML using the provided or the default template.
After that it will put all the documentation in
docs folder of the package directory.
Firstly add your object to a category. The category can be named any you like.
//metadoc Prototype category API
Then add an optional description to the object:
/*metadoc Prototype description Desciption goes here. */
Then comment your public API like this:
//doc Prototype slotName(args) Description
You can also use markdown in your comments. It will be parsed to equivalent HTML code during generation.
You should provide two template files:
The first one is used to generate the main page.
The second is for the documentation pages.
In the HTML files you can use Io code:
template folder to get an example.
Docio site was fully generated with Docio itself.