From: Felix von Delius <fvdelius@...>
Date: 2002-08-29T01:05:27+09:00
Subject: RDoc question: how to markup method parameters and return values?

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