2.13. Ruby Documentation

When I say "Section 2.13," I am mostly referring to the documentation that is generated by RDoc (http://rdoc.sourceforge.net/), a program that extracts documentation from Ruby source files, both C and Ruby files.

The documentation is stored in comments in the source files, and encoded so that RDoc can easily find it. For example, equals signs (such as ===) on the left margin set off a heading, and indented text is formatted as code. RDoc can generate output as HTML, XML, ri (Ruby information), or Windows help (chm) files.