CFC.Doc - Code Documentation Generator for ColdFusion Components

CFC.Doc is a tool for generating API documentation in HTML format. CFC.Doc will scan a directory for all the CFCs and create "Javadoc" style documentation from the meta data. Share the documentation with your development team to keep everybody on the same page. Install the documentation in your favorite IDE to keep it at your fingertips!

Features

processes multiple files and directories recursively
skinnable look and feel with CSS
customizable header and footer
immediately view the generated files in the browser
generate help plug-in for Eclipse
generates project files to create .chm file
generates both frames and no frames views
generates documention in PDF format

Example Documentation

Mach-II framework (View with frames) (PDF)
CFCUnit (View with frames)
Reactor (View with frames) (CHM)
Example with comments in file header: trace.cfc (source) (documentation)
Example with "Javadoc" tags in file header: ApplicationPlugin.cfc (source) (documentation)

System Requirements

Java Runtime 1.4.x must be installed and on the path
Operating system: Windows XP/2000, Mac OS X, Linux

Pricing

Single user license: ~~$35~~ $25 Save $10! [Buy now]
Site license: $150 USD [Buy now]

Download

Try CFC.Doc by downloading the demo. The demo is fully functional but it will only process one out of three files.

cfcdoc_1_0_81_demo.zip (standalone demo for Windows)
cfcdoc_1_0_81_demo.tar.gz (standalone demo Mac OS X/Linux)

Please note:The trial key installed in demo has expired. Please edit <cfcdoc-install>/server/wwwroot/config/config.xml with this license key: CFCDOC-100-00004-1207-5734

Frequently Asked Questions

How do I install the documentation in Eclipse?

Expand the zip file of the docs inside the Eclipse plugins directory. If you change the directory name you must change ID value in the plugin.xml file to match the directory name.

How do I install the documentation in CFStudio/Homesite?

Expand the zip file inside the Help directory. The name of the directory will be the name displayed in the Help References Window. Feel free to rename the directory.

Can I create a Compiled HTML Help file (.chm) using CFC.Doc?

Yes. CFC.Doc will create a .hhp file which you can use with Microsoft's HTML Help Workshop to create .chm files.

How is CFC.Doc different from Spike's CFC Documentation Tool?

Spike's tool runs dynamically and requires CFMX to be running (and accessible). CFC.Doc generates static files (HTML/PDF/CHM) that you can use and distribute as you want. CFC.Doc supports BlueDragon.

Release notes

build #81 18 Jan 2005	Added PDF as output format Added Browse function that displays a tree control to choose the directory
build #59 22 Dec 2004	Added support for file header comments (Javadoc or custom)
build #57 17 Dec 2004	Fixed to work with proxies and/or no network connection (reference local DTD)

Contact

If you have any questions please contact me.