Class RDoc::RI::DefaultDisplay
In: lib/rdoc/ri/display.rb
Parent: Object

A paging display module. Uses the RDoc::RI::Formatter class to do the actual presentation.

Methods

display_class_info   display_flow   display_method_info   display_method_list   display_params   list_known_classes   new   page   setup_pager   warn_no_database  

Included Modules

RDoc::RI::Display

Public Class methods

Public Instance methods

display_class_info(klass, ri_reader)

Display information about klass. Fetches additional information from ri_reader as necessary.

display_method_info(method)

Display information about method.

display_params(method)

Display the params for method.

list_known_classes(classes)

List the classes in classes.

page() {|| ...}

Paginates output through a pager program.

setup_pager()

Sets up a pager program to pass output through.

warn_no_database()

Displays a message that describes how to build RI data.

[Validate]

ruby-doc.org is a community service provided by James Britt and Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.