From: noreply@...
Date: 2007-03-20T09:31:14+09:00
Subject: [ ruby-Bugs-4467 ] RDoc looks for doc headers at function prototypes

Bugs item #4467, was opened at 2006-05-13 04:50
You can respond by visiting: 
http://rubyforge.org/tracker/?func=detail&atid=1698&aid=4467&group_id=426

Category: Standard Library
Group: None
Status: Open
Resolution: None
Priority: 3
Submitted By: Tilman Sauerbeck (tilman)
>Assigned to: Eric Hodel (drbrain)
Summary: RDoc looks for doc headers at function prototypes

Initial Comment:
RDoc looks for documentation chunks at function prototypes, too.

So if you have the snippet of code below, it won't work correctly.
I expect RDoc to pick up the doc header from the implementation of the function, not from the prototype.

Here's the example code:

static VALUE some_prototype (...);

/* more code */

/*
 * call-seq: ..
 * ...
 */
static VALUE
some_prototype (actually_the_implementation)
{
   ...
}

----------------------------------------------------------------------

You can respond by visiting: 
http://rubyforge.org/tracker/?func=detail&atid=1698&aid=4467&group_id=426