Class RDoc::RI::DefaultDisplay
In: lib/rdoc/ri/display.rb
Parent: Object
CodeObject Include Context Alias Attr AnyMethod Constant Require ClassModule NormalModule SingleClass AnonClass NormalClass TopLevel RubyParser RubyToken RuntimeError Error Error AttributeFormatter AnsiFormatter OverstrikeFormatter HtmlFormatter DefaultDisplay NamedThing IncludedModule Attribute Constant MethodSummary AliasName ClassEntry TopLevelEntry Description MethodDescription ModuleDescription ClassDescription Formatter SimpleFormatter HTML HTMLInOne XML CHM Context Method Class File Element Edge Node Subgraph Digraph SimpleElement Port Options Diagram Fortran95parser RDoc SimpleParser Token Markup TemplatePage Stats C_Parser NameDescriptor Cache Reader Writer Driver MethodEntry RI AllReferences Display Paths RI MarkUp Generator TokenStream ParserFactory DOT RDoc dot/f_4.png

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]