In Files
- rdoc/ri/ri_cache.rb
- rdoc/ri/ri_descriptions.rb
- rdoc/ri/ri_display.rb
- rdoc/ri/ri_driver.rb
- rdoc/ri/ri_formatter.rb
- rdoc/ri/ri_options.rb
- rdoc/ri/ri_paths.rb
- rdoc/ri/ri_reader.rb
- rdoc/ri/ri_writer.rb
- rdoc/usage.rb
Namespace
- MODULE RI::Paths
- CLASS RI::AliasName
- CLASS RI::AnsiFormatter
- CLASS RI::Attribute
- CLASS RI::AttributeFormatter
- CLASS RI::ClassDescription
- CLASS RI::ClassEntry
- CLASS RI::Constant
- CLASS RI::Description
- CLASS RI::HtmlFormatter
- CLASS RI::IncludedModule
- CLASS RI::MethodDescription
- CLASS RI::MethodEntry
- CLASS RI::MethodSummary
- CLASS RI::ModuleDescription
- CLASS RI::NamedThing
- CLASS RI::Options
- CLASS RI::OverstrikeFormatter
- CLASS RI::RiCache
- CLASS RI::RiReader
- CLASS RI::RiWriter
- CLASS RI::SimpleFormatter
- CLASS RI::TextFormatter
- CLASS RI::TopLevelEntry
Files
Class/Module Index
![[+]](/images/find.png "show/hide quicksearch")
- DOT
- DOT::DOTDigraph
- DOT::DOTEdge
- DOT::DOTElement
- DOT::DOTNode
- DOT::DOTPort
- DOT::DOTSimpleElement
- DOT::DOTSubgraph
- DefaultDisplay
- Generators
- Generators::AllReferences
- Generators::CHMGenerator
- Generators::ContextUser
- Generators::HTMLGenerator
- Generators::HTMLGeneratorInOne
- Generators::HtmlClass
- Generators::HtmlFile
- Generators::HtmlMethod
- Generators::HyperlinkHtml
- Generators::MarkUp
- Generators::RIGenerator
- Generators::XMLGenerator
- NameDescriptor
- Object
- Options
- Options::OptionList
- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::C_Parser
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::Diagram
- RDoc::Fortran95parser
- RDoc::Fortran95parser::Fortran95Definition
- RDoc::Include
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Page
- RDoc::ParserFactory
- RDoc::RDoc
- RDoc::RDoc::Dir
- RDoc::RDoc::File
- RDoc::RDocError
- RDoc::Require
- RDoc::RubyParser
- RDoc::SimpleParser
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Token
- RDoc::TopLevel
- RI
- RI::AliasName
- RI::AnsiFormatter
- RI::Attribute
- RI::AttributeFormatter
- RI::AttributeFormatter::AttrChar
- RI::AttributeFormatter::AttributeString
- RI::ClassDescription
- RI::ClassEntry
- RI::Constant
- RI::Description
- RI::HtmlFormatter
- RI::IncludedModule
- RI::MethodDescription
- RI::MethodEntry
- RI::MethodSummary
- RI::ModuleDescription
- RI::NamedThing
- RI::Options
- RI::Options::OptionList
- RI::OverstrikeFormatter
- RI::Paths
- RI::RiCache
- RI::RiReader
- RI::RiWriter
- RI::SimpleFormatter
- RI::TextFormatter
- RI::TopLevelEntry
- RiDisplay
- RiDriver
- RiError
- RubyLex
- RubyLex::BufferedReader
- RubyToken
- RubyToken::TkError
- RubyToken::TkId
- RubyToken::TkKW
- RubyToken::TkNode
- RubyToken::TkOPASGN
- RubyToken::TkOp
- RubyToken::TkUnknownChar
- RubyToken::TkVal
- RubyToken::Token
- SM
- SM::AttrChanger
- SM::AttrSpan
- SM::Attribute
- SM::AttributeManager
- SM::BlankLine
- SM::BlankLine::Line
- SM::Flow
- SM::Flow::LIST
- SM::Fragment
- SM::Heading
- SM::Heading::Line
- SM::Line
- SM::LineCollection
- SM::Lines
- SM::ListBase
- SM::ListEnd
- SM::ListItem
- SM::ListItem::Line
- SM::ListStart
- SM::Paragraph
- SM::Paragraph::Line
- SM::PreProcess
- SM::Rule
- SM::Rule::Line
- SM::SimpleMarkup
- SM::Special
- SM::ToFlow
- SM::ToHtml
- SM::ToLaTeX
- SM::Verbatim
- SM::Verbatim::Line
- TemplatePage
- TemplatePage::Context
- TemplatePage::LineReader
- TokenStream
RI
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
We handle the parsing of options, and subsequently as a singleton object to be queried for option values
Constants
Commenting is here to help enhance the documentation. For example, sample code, or clarification of the documentation.
If you are posting code samples in your comments, please wrap them in "<pre><code class="ruby" > ... </code></pre>" markup in order to get syntax highlighting.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file a bug report so that it can be corrected for the next release. Thank you.