From: Dave Thomas <Dave@...>
Date: 2002-03-03T12:49:16+09:00
Subject: Re: RDoc question

Michael Davis <mdavis@sevainc.com> writes:

> I would be happy with the following:
> 
>     rdoc.rb file1.rb file2.txt

OK - the latest CVS now supports arbitrary files on the command
line. If you specify a directory name, just .rb, .rbw, and .c files
will be processed from tat directory and its subdirectories. If you
specify explicit file names, each file named will be processed. '.rb'
and 'rbw' files are parsed as Ruby, '.c' as C extensions. All others
are assumed to contain _just_ simple markup (with or without a leading
'#' sign). You can hyperlink between all file types.

For example, you might say

   rdoc README lib

to document your README file and all .rb files in lib/. In the file
lib/main.rb, a comment containing

   # See the README for details

will generate the correct hyperlink.


Cheers


Dave


ps. A certain Professor is working on generating .pdfs from
RDoc. Watch this space.....