If you use CFCDoc, it will recognize a 'throws' attribute to
CFFUNCTION, along with 'deprecated', and include them in the generated
docs.  An example and download are at
http://www.spike.org.uk/projects/cfcdoc/

And yes, that feature is mine.  ;)  I added it explicitly for this
purpose, since most of my APIs depend on 'checked' exceptions (in as
much as CF will allow you to do that), along with several other
enhancements.

cheers,
barneyb

On 10/25/05, Peter J. Farrell <[EMAIL PROTECTED]> wrote:
> David Ross wrote:
>
> >the cool thing is that by having a hasSpouse() and a getSpouse() that
> >throws NotMarried, you leave the choice up the client (thus it's a good
> >practice to put "Throws: NotMarriedException when there is no spouse"
> >into the getSpouse()'s hint).
> >
> >-Dave
> >
> I typically do something like this:
>
> <cffunction name="getSpouse" access="public" returntype="someObj"
> output="false"
>     hint="I get the spouse obj.<br/>
>     Throws: NotMarriedException when there is no spouse.">
>     ... stuff ...
> </cffunction>
>
> The <br/> makes the CFCExplorer output nice and pretty...
>
> .Peter
>
> --
> Peter J. Farrell :: Maestro Publishing
> http://blog.maestropublishing.com
>


--
Barney Boisvert
[EMAIL PROTECTED]
360.319.6145
http://www.barneyb.com/

Got Gmail? I have 100 invites.


----------------------------------------------------------
You are subscribed to cfcdev. To unsubscribe, send an email to 
[email protected] with the words 'unsubscribe cfcdev' as the subject of the 
email.

CFCDev is run by CFCZone (www.cfczone.org) and supported by CFXHosting 
(www.cfxhosting.com).

CFCDev is supported by New Atlanta, makers of BlueDragon
http://www.newatlanta.com/products/bluedragon/index.cfm

An archive of the CFCDev list is available at 
www.mail-archive.com/[email protected]


Reply via email to