A documentation generator for CFML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
themes/default
LICENSE
README.md
cfmldoc.livecode

README.md

cfmldoc version 0.1

A documentation generator for CFML

This is a documentation generator for CFML.

It's written in LiveCode, and binaries will be available for multiple platforms (Linux and Windows tested so far).

It relies on there being JavaDoc/YUIDoc style comments in the source code, which goes well with a sublime plugin I wrote for creating just that. (Available soon)

https://github.com/MFernstrom/cfmldocplugin

I'm doing the last bit of testing now, and will release version 0.1 within days.

It has support for basic templating, and comes with a not-so-pretty-but-usable template.

The root folder is assumed to be the root project folder, and the extends link generation is not intelligent yet, it builds a link based off of the root rather than actual tracing.

Binaries will be available as well as the source.