Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • rdoc/ri/ri_cache.rb
  • rdoc/ri/ri_descriptions.rb
  • rdoc/ri/ri_display.rb
  • rdoc/ri/ri_driver.rb
  • rdoc/ri/ri_formatter.rb
  • rdoc/ri/ri_options.rb
  • rdoc/ri/ri_paths.rb
  • rdoc/ri/ri_reader.rb
  • rdoc/ri/ri_writer.rb
  • rdoc/usage.rb


Class/Module Index [+]



Descriptions are created by RDoc (in ri_generator) and written out in serialized form into the documentation tree. ri then reads these to generate the documentation

We handle the parsing of options, and subsequently as a singleton object to be queried for option values



Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.