Type:
Class

The RI driver implements the command-line ri tool.

The driver supports:

  • loading RI data from:

    • Ruby's standard library

    • RubyGems

    • ~/.rdoc

    • A user-supplied directory

  • Paging output (uses RI_PAGER environment variable, PAGER environment variable or the less, more and pager programs)

  • Interactive mode with tab-completion

  • Abbreviated names (ri Zl shows Zlib documentation)

  • Colorized output

  • Merging output from multiple RI data sources

expand_name
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

expand_name(name) Instance Public methods Expands the class portion of name

2025-01-10 15:47:30
classes
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

classes() Instance Public methods

2025-01-10 15:47:30
display
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

display(document) Instance Public methods Converts document to

2025-01-10 15:47:30
add_includes
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

add_includes(out, includes) Instance Public methods Adds includes

2025-01-10 15:47:30
ancestors_of
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

ancestors_of(klass) Instance Public methods Returns ancestor classes of klass

2025-01-10 15:47:30
display_class
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

display_class(name) Instance Public methods Outputs formatted RI data for class

2025-01-10 15:47:30
display_page_list
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

display_page_list(store, pages = store.cache[:pages], search = nil) Instance Public methods

2025-01-10 15:47:30
load_methods_matching
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

load_methods_matching(name) Instance Public methods Returns an Array of RI data

2025-01-10 15:47:30
display_page
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

display_page(name) Instance Public methods Outputs formatted RI data for page

2025-01-10 15:47:30
filter_methods
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

filter_methods(found, name) Instance Public methods Filters the methods in found

2025-01-10 15:47:30