API Documentataion?

3 views
Skip to first unread message

Daniel Lancelot

unread,
Dec 12, 2008, 10:39:58 AM12/12/08
to DataFaucet Mailing List
Hi,

Is there any API documentation for the core datafaucet classes?

Just after something that lists the methods, hints, signatures etc. - it seems like not all the methods are listed in the current documentation (although what is there is good and very helpful)

Thanks,

Dan.

Isaac Dealey

unread,
Dec 12, 2008, 12:20:48 PM12/12/08
to dataf...@googlegroups.com

No there's not a comprehensive object/method reference currently.
You're thinking of something like the tag and function references for
ColdFusion in Adobe's LiveDocs. It's good stuff, but it can take a lot
of time to write and as of yet just hasn't been a high priority. I've
focused primarily on a more subject-matter / tutorial-style approach to
documentation. Although there actually is that kind of reference
documentation for the onTap framework... well most of it. ;)


--
[ ike ] founder - DataFaucet ORM

phone: 781.769.0723

http://www.datafaucet.com


Daniel Lancelot

unread,
Dec 13, 2008, 6:39:05 PM12/13/08
to dataf...@googlegroups.com
Hi Ike,

No problems, I created my own...

(with a little help from Mark Mandel's excellent ColdDoc tool http://colddoc.riaforge.org/ !!!)

This generates JavaDoc style API documentation for CFC's - which is pretty much what I wanted :)

I've attached the docs to this email - not certain if google groups allows this...

Best regards,

Dan.
datafaucet_colddocs.rar

Isaac Dealey

unread,
Dec 13, 2008, 9:54:40 PM12/13/08
to dataf...@googlegroups.com
Thanks Dan!

I uploaded these to the site at
http://www.datafaucet.com/datafaucet/api

Reply all
Reply to author
Forward
0 new messages