From: Joel VanderWerf <vjoel@...>
Date: 2002-01-04T02:53:43+09:00
Subject: [ruby-talk:30146] Re: Rubydoc ?

Vincent Bernat wrote:
> 
> Hi !
> 
> I am a bit disappointed with the documentation tool "rdtool". The
> ".rd" is separated from the ".rb" and it may be a pain to keep the two
> in sync.

This is from the pickaxe book chapter on embedded docs:

  RD documentation can be included directly in a Ruby source
  program or written into a separate file (which by convention
  will have the extension .rd).

I always keep docs in the same file and run rd2html on my .rb file, to
help keep things in sync.

> However, it seems that is the standard tool for documenting
> ruby program.

The emerging standard seems to be rdoc:
  http://rdoc.sourceforge.net
It looks very nice, but I haven't used it yet.