RE: [Reactor for CF] CFC Documentation (Was Documentation Broken)

Fri, 04 Aug 2006 12:03:59 -0700

This is freakin awesome. ( I am such a kid in a candy store right now. )

From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Chris Blackwell
Sent: Friday, August 04, 2006 2:31 PM
To: [email protected]
Subject: [Reactor for CF] CFC Documentation (Was Documentation Broken)

I use CFCDoc (http://www.spike.org.uk/projects/cfcdoc/) for my cfcs.  It is exactly like JavaDoc, using the “hint” attribute to create the descriptions in the documentation and optionally including the source code for each function.

Its very easy to use and recompiles the documentation on the fly which is very handy during development.

 

To create a static version of the docs for distribution or posting online I use HTTrack (http://www.httrack.com/)

 

I also use this in my dev environment to show me the Reactor, ModelGlue and Coldspring api’s

 

Cheers, Chris

 

 

 

 

From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Teddy Payne
Sent: 04 August 2006 18:13
To: [email protected]
Subject: Re: [Reactor for CF] Documentation Broken

 

For the documentation, I usually go to the RoboHelp web site for reactor:

http://livedocs.reactorframework.com

RoboHelp is a tool that Adobe inherited from Macromedia that assists with help documentation.

For CFC automatic documentation, the "hint" attribute to the <cfcomponent> and <cffunction> tags is the one of the primary ways.

The hints are typically written in first person with the perspective of the function or the component.

Teddy

On 8/4/06, Marc Funaro <[EMAIL PROTECTED]> wrote:

I just grabbed reactor using svn, and all is downloaded.

I went to the documentation folder and clicked on index.htm, and it's
broken... Tries to do

<body />

But there is no such file on my file system.


On a related question:  I like how this documentation is laid out... It
would be great to have similar documentation on my projects.  What is
RoboEditor?  I searched on Google but all I found was reference to

"ROBOEDITOR (TM) is an advanced data mining tool which  crawls the Internet
in search of the latest news, saves the information, edits and publishes it
onto websites and portals."

Which doesn't seem to be the same tool that would be used to build this
documentation.

(OT) How is everyone doing their own documentation - especially CFCs?
Anything out there similar in style to the automatic documentation of
classes that java offers?

Thanks as always!

M



-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
Reactor for ColdFusion Mailing List
[email protected]
Archives at: http://www.mail-archive.com/reactor%40doughughes.net/
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --




--
<cf_payne />
http://cfpayne.wordpress.com/
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
Reactor for ColdFusion Mailing List
[email protected]
Archives at: http://www.mail-archive.com/reactor%40doughughes.net/
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --


-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
Reactor for ColdFusion Mailing List
[email protected]
Archives at: http://www.mail-archive.com/reactor%40doughughes.net/
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --

-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
Reactor for ColdFusion Mailing List
[email protected]
Archives at: http://www.mail-archive.com/reactor%40doughughes.net/
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --

Reply via email to