From: GOTO Kentaro <gotoken@...>
Date: 2002-09-22T15:30:21+09:00
Subject: Re: class documentation

At Sat, 21 Sep 2002 22:15:09 +0900,
Mark Volkmann wrote:
> 
> Is there a general concensus as to the best tool/format for documenting Ruby
> classes?

No, there isn't as far as I know.  

Tosh's rdtool and Dave's RDoc are popular tools and I think that RDoc
is better for the purpose to write class documents.

But I prefer RD because rdtool's rd2 command dumps html to stdout and 
allows me to do

  % rd2 something.rb | w3m

with a text html browser w3m, which is similar to lynx or links.  

I'll be converted to RDoc if I get known how to do same thing with rdoc. 

-- Gotoken