23 November 2008 01:02 PM
ColdDoc 0.1 Released
ColdDoc 0.1 is finally ready as a release version.
ColdDoc is a port of JavaDoc for ColdFusion, and generates static .html files that display API information for a collection of CFCs.
ColdDoc was initially written to output the API documentation for Transfer, which can be seen here .
The benefits of outputting documentation to static html files, rather than doing it dynamically include:
- Less processing at run time
- Documentation can be linked to, without fear of page names and/or anchors changing
- The ability to generate API details such as Direct known subclasses and Method Overrides information which would be too expensive to determine at run time.
Currently ColdDoc only supports a single root path, and is missing some JavaDoc implementations, such as a Index page, and Interface documentation, and can only run on ColdFusion 8.
ColdDoc can be downloaded from here .
Comments
Posted by Todd Sharp on 23 November 2008 01:58 PM
Wow man that is _very_ nice work. Can't wait to try it out.
Posted by John Whish on 24 November 2008 01:01 AM
Nice - very nice! Thanks for sharing :)
Posted by David Lakein on 25 November 2008 05:36 AM
Very nice!
I'm trying it out on a large CFC-based app we are refactoring for a client, and works nicely so far. I had one main issue getting it running (besides the parse error I found in one component), that in the template HTML files that are included, they declare local variables that aren't var scoped.
This caused an error with a local var init, which conflicted with the ColdDoc.cfc's init() method.
I'll put up an issue on riaforge.
Thanks!
Posted by Gary on 13 December 2008 02:35 PM
Hi Mark. Just downloaded your tool and tried to give it a run. I ran into the following error I thought you could help me with before I go hacking away. Thanks!
Element NAME is undefined in INIT.
The error occurred in C:\ColdFusion8\wwwroot\ColdDoc\resources\templates\class.html: line 223
Called from C:\ColdFusion8\wwwroot\ColdDoc\resources\templates\class.html: line 1
Called from C:\ColdFusion8\wwwroot\ColdDoc\ColdDoc.cfc: line 260
Called from C:\ColdFusion8\wwwroot\ColdDoc\ColdDoc.cfc: line 98
Called from C:\ColdFusion8\wwwroot\ColdDoc\ColdDoc.cfc: line 71
Called from C:\ColdFusion8\wwwroot\ColdDoc\ColdDoc.cfc: line 32
Called from C:\ColdFusion8\wwwroot\ColdDoc\run.cfm: line 11
221 : </tbody></table>
222 :
223 : <a name="#init.name#()"><!-- --></a><h3>
224 :
225 : #init.name#</h3>
Posted by Mark on 14 December 2008 09:44 AM
Gary,
What CF server are you running on? (exact version, as I usually run 8.0.1)
Can you show me the code you were trying to use to run it?
What platform are you on, Windows, Mac?
Posted by Steve Brownlee on 27 January 2009 03:03 AM
Hey Mark, thanks for this great project. Unfortunately, I'm getting the same error as Gary. I see it at soon as I execute the run.cfm file.
I put in some fixes to work around it, but thought I'd report it.
ColdFusion 8.0.1 Developer - Multiserver install
Windows XP SP2
JDK 1.6.0_10
Posted by Mark on 28 January 2009 07:28 AM
@Steve,
Thanks for letting me know. There is actually a fix for this in SVN I wrote a while back, I was just waiting on some user testing... which I then prompty forgot about. I'll chase it up and do a new release.
Posted by Gary on 03 February 2009 12:30 PM
Work like a charm now!
Thanks Mark!!!