From: Dave Thomas <Dave@...>
Date: 2003-08-15T23:38:36+09:00
Subject: Re: Main page for RDoc


On Friday, August 15, 2003, at 09:23 AM, Brian Candler wrote:
> Thank you for pointing me in the right direction. That misses 
> EXAMPLE.rb, so
> I tried
>         rdoc --main README README .
> which gives *more* entries in the 'Files' section than the one on 
> Dave's
> site, but at least I understand what I need to do.

Have a look at web/upload.sh for the command I issue to generate the 
sample documentation. It's more complex than you'd normally use, 
because I wanted to show features without formatting up all the source 
code's documentation.

> I ran rdoc on some existing code of mine and got no comments - but I 
> have
> been using '=begin ... =end' rather than #'s in front of large blocks. 
> Do
> you know whether there's a way to get it to process such things, or do 
> I
> need to reformat all my comments?
>
Right now it ignores =begin/=end - I once included them, but discovered 
that

1. It clashes with RD
2. Some folks use =begin/=end to comment out large chunks of code.

I guess I could add an option to support them if there was a big-enough 
need. What do folks think?


Dave