[LRUG] Writing Module Docs (RDoc?)

Ash Berlin ash_lrug at firemirror.com
Fri Feb 11 02:54:55 PST 2011


On 11 Feb 2011, at 10:51, Chris Lowis wrote:
>> Any pointers?
> 
> Are the "Example" and "Markup" sections of this document any use?
> 
> http://rdoc.sourceforge.net/doc/files/README.html
> 
> 
> Cheers,
> 
> Chris

It's some use, certainly for the formatting codes.

Does RDoc just look at the comment immediately before a class or method then? i.e. how do comments map to the output of running rdoc?

-ash


More information about the Chat mailing list