Velocity Reviews

Velocity Reviews (http://www.velocityreviews.com/forums/index.php)
-   Ruby (http://www.velocityreviews.com/forums/f66-ruby.html)
-   -   rdoc Question: How to document which exceptions a function raises (http://www.velocityreviews.com/forums/t816924-rdoc-question-how-to-document-which-exceptions-a-function-raises.html)

Brian Schröder 09-26-2004 12:50 PM

rdoc Question: How to document which exceptions a function raises
 
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



Austin Ziegler 09-26-2004 02:21 PM

Re: rdoc Question: How to document which exceptions a function raises
 
On Sun, 26 Sep 2004 21:50:27 +0900, Brian Schröder
<ruby@brian-schroeder.de> 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 * halostatue@gmail.com
* Alternate: austin@halostatue.ca
: as of this email, I have [ 6 ] Gmail invitations





All times are GMT. The time now is 10:56 AM.

Powered by vBulletin®. Copyright ©2000 - 2014, vBulletin Solutions, Inc.
SEO by vBSEO ©2010, Crawlability, Inc.