From: Austin Ziegler <austin@...>
Date: 2003-04-12T07:10:12+09:00
Subject: Re: [q]class documentation

On Sat, 12 Apr 2003 06:00:30 +0900, Bermejo, Rodrigo wrote:
> Hi all;
> There are some ("native") mechanism to add documentation into my
> class code?

If you're referring to a Python-like "document-string", no. However:

    # Just an example
  class Myclass
      # Reverses +string+.
    def reverse(string)
      string.reverse
    end
  end

You can then run this through rdoc and it will be documented.
Honestly, I can't think of many times that programmatic access to
the documentation would be useful.

HOWEVER ... the one time that I do need it is when I'm in irb. It
might be nice to have irb add an "ri" method to Object that does an
appropriate "ri" lookup...

-austin
-- Austin Ziegler, austin@halostatue.ca on 2003.04.11 at 18:06:16