RDoc question: how to markup method parameters and return values?

ruby-talk
1

I have a question regarding RDoc: How do I comment the parameters of
a method right? Is there something like the @param and @return tag in
JavaDoc?

Currently I’ve done it this way:

…

···

do something useful

a:: magic value

b:: more magic value

return:: a UseLess object made out of magic a and b

def doSth(a, b)
return UseLessClass.new(a,b)
end

…

Please excuse me if the is an FAQ, but I couldn’t find any examples in
the online documentation and in this list.

Cheers,
Felix

2

Felix von Delius fvdelius@t-online.de writes:

I have a question regarding RDoc: How do I comment the parameters of
a method right? Is there something like the @param and @return tag in
JavaDoc?

The currently is no way: it’s kind of a subversive way to make folks
use meaningful parameter names… :slight_smile:

However, to support the C API, it looks like I’ll be adding this
feature in the future.

Cheers

Dave

3

Dave Thomas wrote:

The currently is no way: it’s kind of a subversive way to make folks
use meaningful parameter names… :slight_smile:

However, to support the C API, it looks like I’ll be adding this
feature in the future.

While we’re discussing this, I’ve wondered what to do about documenting
overloaded instance methods. There are several of these in FXRuby but
also in core Ruby libraries as well. If there’s no obvious way to
support it in RDoc, maybe at least establish some conventions for how
the method’s documentation should read…