Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Ruby > rdoc Question: How to document which exceptions a function raises

Reply
Thread Tools

rdoc Question: How to document which exceptions a function raises

 
 
Brian Schröder
Guest
Posts: n/a
 
      09-26-2004
Hello Group,

is there already a possibility in rdoc to document which exceptions a
function raises? Somethink like the :yield: keyword.

I did not find anything in the rdoc documentation.

regards,

Brian Schröder


 
Reply With Quote
 
 
 
 
Austin Ziegler
Guest
Posts: n/a
 
      09-26-2004
On Sun, 26 Sep 2004 21:50:27 +0900, Brian Schröder
<> wrote:
> Hello Group,
>
> is there already a possibility in rdoc to document which exceptions a
> function raises? Somethink like the :yield: keyword.
>
> I did not find anything in the rdoc documentation.


Best to write it out if you must document it. Having something more or
less automatically generated leads to the concept of "checked"
exceptions, which C++ and Java users are now realising were a huge
mistake.

-austin
--
Austin Ziegler *
* Alternate:
: as of this email, I have [ 6 ] Gmail invitations



 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Re: How include a large array? Edward A. Falk C Programming 1 04-04-2013 08:07 PM
[RDOC] Using a template causes rdoc not to document some classes Daniel Berger Ruby 1 11-02-2004 08:23 PM
deepcopy raises TypeError for method/function? OKB (not okblacke) Python 3 09-10-2004 06:17 AM
rdoc: how to generate rdoc & ri documentation of standard library? Andreas Schwarz Ruby 6 01-01-2004 03:09 AM
Uncatchable AttributeError, shelve raises exceptions in __del__ seth Python 0 10-12-2003 05:50 PM



Advertisments
 



1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57