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

System Requirements

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

Download

Get the application from the project download page.

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

Jan 2010
18 Jan 2005
  • Added PDF as output format
  • Added Browse function that displays a tree control to choose the directory
22 Dec 2004
  • Added support for file header comments (Javadoc or custom)
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.