Module RDoc::RI::Display
In: lib/rdoc/ri/display.rb
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

This is a kind of ‘flag’ module. If you want to write your own ‘ri’ display module (perhaps because you‘re writing an IDE), you write a class which implements the various ‘display’ methods in RDoc::RI::DefaultDisplay, and include the RDoc::RI::Display module in that class.

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

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

Methods

append_features   new  

Public Class methods

[Validate]