From: Vincent Bernat <bernat@...>
Date: 2002-01-04T02:31:04+09:00
Subject: [ruby-talk:30143] Rubydoc ?

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. However, it seems that is the standard tool for documenting
ruby program.

With Javadoc, keeping in sync the doc and the code is more easy ; the
doc is embedded in the code and the tool maintains coherence : you
cannot comment a parameter which is not a parameter of the function,
you cannot say you throw an exception you don't throw.

I have found a tool called rubydoc which tries to mimic Javadoc
feature, however, it is very basic. I have found with Google an "old"
thread about comments (/* */ comments) but it is very difficult to
follow since threads are broken.

Is there a way to use rdtool with an approach closer to Javadoc ? Or
is it a good tool that would fit my needs (maybe a tool which
transforms embedded docs into .rd) ?
-- 
BOFH excuse #5:
static from plastic slide rules