We handle the parsing of options, and subsequently as a singleton object to be queried for option values
From rdoc/ri/ri_descriptions.rb
Descriptions are created by RDoc (in ri_generator) and written out in serialized form into the documentation tree. ri then reads these to generate the documentation
| Modules | |
|---|---|
| Paths | Encapsulate all the strangeness to do with finding out where to find RDoc files |
| Classes | |
|---|---|
| AliasName | Alias = Struct.new(:old_name, :new_name) |
| AnsiFormatter | This formatter uses ANSI escape sequences to colorize stuff works with pages such as man and less. |
| Attribute | |
| AttributeFormatter | Handle text with attributes. We’re a base class: there are different presentation classes (one, for example, uses overstrikes to handle bold and underlining, while another using ANSI escape sequences |
| ClassDescription | |
| ClassEntry | |
| Constant | |
| Description | |
| HtmlFormatter | This formatter uses HTML. |
| IncludedModule | |
| MethodDescription | |
| MethodEntry | |
| MethodSummary | |
| ModuleDescription | |
| NamedThing | |
| Options | |
| OverstrikeFormatter | This formatter generates overstrike-style formatting, which works with pagers such as man and less. |
| RiCache | We represent everything know about all ‘ri’ files accessible to this program |
| RiReader | |
| RiWriter | |
| SimpleFormatter | This formatter reduces extra lines for a simpler output. It improves way output looks for tools like IRC bots. |
| TextFormatter | Finally, fill in the list of known formatters |
| TopLevelEntry | A TopLevelEntry is like a class entry, but when asked to search for methods searches all classes, not just itself |
| Constants | |
|---|---|
| VERSION_ |
|
<code/>and<pre/>for code samples.