From: Dave Thomas <dave@...>
Date: 2004-01-02T14:52:35+09:00
Subject: Re: Confused abour 'ri' in 1.8.1?


On Jan 1, 2004, at 23:01, jbritt@ruby-doc.org wrote:
> If it seems worthwhile, I can generate the ri files for 1.8.1 and host 
> them on ruby-doc.org.

Please don't, yet: things are changing.

For now, everyone can generate their own RDoc documentation which is 
equivalent to (actually better than) the original 'ri' by doing

    rdoc --all --ri *.c

in the main Ruby source directory of the CVS distribution. As of 
tonight, it documents every single built-in class, module, and method. 
On my fairly pokey laptop, this doesn't take too long:

     dave[ruby/ruby 23:32:01] rdoc --all --ri *.c

                             array.c:
                            bignum.c:
                           ....
                          variable.c:
                           version.c:

    Generating RI...

    Files:   39
    Classes: 61
    Modules: 16
    Methods: 1094
    Elapsed: 55.074s

Pretty soon this will all be transparent: the ri documentation will be 
available out of the box.

As for the lib/ and ext/ stuff: rdoc runs OK on it all (see below), but 
to be honest the quality of the documentation in there is very patchy. 
I frankly wouldn't bother with the lib/ documentation for a while.

In the meantime, I'm more than happy to answer questions about the 
documentation stuff.


Cheers

Dave


ps.

Running the latest RDoc on the interpreter and lib/ yields:

   Files:   114
   Classes: 328
   Modules: 76
   Methods: 2681
   Elapsed: 349.075s