From: jweirich@...
Date: 2001-12-17T07:38:54+09:00
Subject: [ruby-talk:28716] Re: RDoc - Document Ruby source files

>>>>> "Dave" == Dave Thomas <Dave@PragmaticProgrammer.com> writes:

    Dave> There's an alpha version of my Ruby documentation package
    Dave> available at [...]

Wonderful!  I'm excited to see this!

    Dave> I'm sure this code has many holes, so I'd appreciate feedback, bug
    Dave> reports, fixes, and so on.

Hmmm ... When I try it, the class level comments get applied to each
and every method in the class.  None of the method level comments
appear at all.  Also, you see %param% instead of the method name with
its parameters.

I'm using ruby 1.6.4.

Here is the example output for the following code.  Notice the class
level comment applied to the do_it method.

    http://w3.one.net/~jweirich/doc/

----------------------------------------------------------------------
#!/usr/bin/env ruby

# This is a file level comment.

require 'ftool'

# This is a class level comment

class Sample

  # This is a method level comment.

  def do_it
  end
end
----------------------------------------------------------------------

    Dave> I'm also hoping people will be writing different backends
    Dave> for it (like the UML diagram generator that was discussed a
    Dave> while back). If you want to do that, drop me an e-mail and
    Dave> we can discuss the interface.

I would like to see a back end that generates data compatible with the
"ri" command.

-- 
-- Jim Weirich     jweirich@one.net    http://w3.one.net/~jweirich
---------------------------------------------------------------------
"Beware of bugs in the above code; I have only proved it correct, 
not tried it." -- Donald Knuth (in a memo to Peter van Emde Boas)