From: Mikael Brockman <mikael@...>
Date: 2004-10-02T03:12:01+09:00
Subject: Re: Ruby source code browsing

Charles Mills <cmills@freeshell.org> writes:

> Hi,
> I am at the Ruby Conf. right now talking to James Britt and Daniel
> Berger.  I just showed them Doxygen documentation I generated from the
> Ruby sources.  It has come in handy developing extensions.
> Here it is:
> http://cmills.freeshell.org
> http://cmills.freeshell.org/ruby_doc.tar.bz2
> 
> Inside this tarball are html files generated by Doxygen.  The file
> modules.html is probably of the most interest.
> 
> To create this documentation I added Doxygen tags to intern.h and
> ruby.h in the Ruby 1.8.1 source tree.  (Instructions are on my
> webpage.)
> Would it be useful to add these tags permanently to the Ruby source?

Yay!  That's really useful.  Of course, it'd be even cooler if
the functions were described in English, too.  Maybe I'll read
up on this Doxygen thing and start documenting.