MENU
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

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

lookup_method(name) Instance Public methods Returns a filtered list of methods

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

load_method(store, cache, klass, type, name) Instance Public methods Loads RI

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

display_name(name) Instance Public methods Outputs formatted RI data for the

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

method_document(name, filtered) Instance Public methods Builds a

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

add_class(out, name, classes) Instance Public methods Adds a class header to

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

display_names(names) Instance Public methods Displays each name in name

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

add_method(out, name) Instance Public methods Looks up the method name

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

classes_and_includes_and_extends_for(name) Instance Public methods Returns the

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

add_method_documentation(out, klass) Instance Public methods Adds documentation

2025-01-10 15:47:30