Module: RiDisplay

Included in:: DefaultDisplay

Defined in:: lib/rdoc/ri/ri_display.rb

Overview

This is a kind of 'flag' module. If you want to write your own 'ri' display module (perhaps because you'r writing an IDE or somesuch beast), you simply write a class which implements the various 'display' methods in 'DefaultDisplay', and include the 'RiDisplay' module in that class.

To access your class from the command line, you can do

ruby -r <your source file>  ../ri ....

If folks really want to do this from the command line, I'll build an option in

Constant Summary collapse

@@display_class =

nil

Class Method Summary collapse

.append_features(display_class) ⇒ Object
.new(*args) ⇒ Object

Class Method Details

.append_features(display_class) ⇒ `Object`



22
23
24

# File 'lib/rdoc/ri/ri_display.rb', line 22

def RiDisplay.append_features(display_class)
  @@display_class = display_class
end

.new(*args) ⇒ `Object`



26
27
28

# File 'lib/rdoc/ri/ri_display.rb', line 26

def RiDisplay.new(*args)
  @@display_class.new(*args)
end