Re: beginner instructions on how to create rdoc documentation

> > Can anybody recommend some documentation for a first-time ruby  
> > documentation
> > writer?  So far, all I've found is sample documented code.
> 
> Have you seen this yet?
> 
> http://ruby-doc.org/documentation-guidelines.html

I have.  It's not really what I had in mind.  I'm hoping there's another page 
that I missed.

Or I could go at this from another angle:
I'm trying to start using the httpclient package (http://raa.ruby-lang.org/proj
ect/http-access2/).  When I ran rdoc to generate the documentation, I found 
the generated documentation to be incomplete, particularly in regards to 
HTTPClient, the main class.  So I decided to submit a patch to the httpclient 
author containing improved documentation.

But when I look at the httpclient source code and compare it to the generated 
rdoc pages, I can't figure out what logic rdoc is using.  There are a lot of 
comments and a lot of methods in the source code that don't turn up in the 
rdoc output.  There's a few places where ':nodoc:' appears, but not enough to 
explain the disparity (at least to me).

So I'm seeking a [better|any] understanding of how rdoc works.

I contacted the author of httpclient about this yesterday, and I haven't heard 
back from him yet.