[Download CF_CFCDocumenter]

[See Example of Documentation for org.changemedia.impart.api.DataGateway]

CF_CFCDocumenter

This custom tag creates documentation for a CFC.

Syntax:

<cf_cfcdocumenter cfc="CFC Instance -or- Fully qualified path to CFC">

By default, this will only document PUBLIC AND REMOTE functions -- to have it document other functions, pass the attribute documentedAccessLevels and make it a comma delimited list of the access levels you want to document. For instance, if you want to document both remote and public functions, you would call:

<cf_cfcdocumenter cfc="..." documentedAccessLevels = "remote,public,private">

Copyright 2003, Nathan Dintenfass (http://nathan.dintenfass.com). All Rights Reserved.

You may use this code freely provided the copyright notice above, the copyright notice in the comments of the generated HTML, and the copyright notice displayed in the HTML remain intact. If you use this for commercial purposes, you are not required to pay any royaltees, but I sure would appreciate it if you would!

USE OF THIS CODE IS AT YOUR OWN RISK. NO WARRANTY IS EXPRESSED OR IMPLIED, AND NATHAN DINTENFASS ASSUMES NO LIABILITY FOR THE RESULT OF USING THIS CODE. BY USING THIS CODE YOU AGREE TO INDEMNIFY AND HOLD NATHAN DINTENFASS HARMLESS FROM ANY LIABILITY, CLAIM OR DEMAND ARISING OUT OF YOUR USE OF THIS CODE.

Comments are welcomed at: nathan AT changemedia DOT com