From: Dave Thomas <Dave@...>
Date: 2002-02-11T00:37:04+09:00
Subject: Re: Ruby Embedded Documentation

ts <decoux@moulon.inra.fr> writes:

>  Well, this was not for docproto.rb but because when I've read 
> 
>  http://rdoc.sourceforge.net
> 
>  I've had the strange impression that it document only #initialize an not
>  ::new. 

If you mean in the comments, then it automatically hyperlinks the
#form, but currently not the ::form. Do you want me to add the ::form
too? It definitely supports

     def A::b
     end

in the source.

In terms of documenting extensions: that's on my list of things to
do. Clearly I can extract out all the rb_defines: the issue is
associating fuller documentation with each. I'm not sure how to do
that.

My final goal here is to move the ri documentation back into the Ruby
source, and then have it extracted out using RDoc. That means there'd
be a single, definitive source for the documentation. This may be a
ways off though. :)



Dave