In Files

  • rdoc.rb
  • rdoc/alias.rb
  • rdoc/anon_class.rb
  • rdoc/any_method.rb
  • rdoc/attr.rb
  • rdoc/class_module.rb
  • rdoc/code_object.rb
  • rdoc/comment.rb
  • rdoc/constant.rb
  • rdoc/context.rb
  • rdoc/context/section.rb
  • rdoc/cross_reference.rb
  • rdoc/encoding.rb
  • rdoc/erb_partial.rb
  • rdoc/erbio.rb
  • rdoc/extend.rb
  • rdoc/generator.rb
  • rdoc/generator/darkfish.rb
  • rdoc/generator/json_index.rb
  • rdoc/generator/markup.rb
  • rdoc/generator/ri.rb
  • rdoc/ghost_method.rb
  • rdoc/include.rb
  • rdoc/known_classes.rb
  • rdoc/markdown.rb
  • rdoc/markdown/entities.rb
  • rdoc/markdown/literals_1_9.rb
  • rdoc/markup.rb
  • rdoc/markup/attr_changer.rb
  • rdoc/markup/attr_span.rb
  • rdoc/markup/attribute_manager.rb
  • rdoc/markup/attributes.rb
  • rdoc/markup/blank_line.rb
  • rdoc/markup/block_quote.rb
  • rdoc/markup/document.rb
  • rdoc/markup/formatter.rb
  • rdoc/markup/formatter_test_case.rb
  • rdoc/markup/hard_break.rb
  • rdoc/markup/heading.rb
  • rdoc/markup/include.rb
  • rdoc/markup/indented_paragraph.rb
  • rdoc/markup/list.rb
  • rdoc/markup/list_item.rb
  • rdoc/markup/paragraph.rb
  • rdoc/markup/parser.rb
  • rdoc/markup/pre_process.rb
  • rdoc/markup/raw.rb
  • rdoc/markup/rule.rb
  • rdoc/markup/special.rb
  • rdoc/markup/text_formatter_test_case.rb
  • rdoc/markup/to_ansi.rb
  • rdoc/markup/to_bs.rb
  • rdoc/markup/to_html.rb
  • rdoc/markup/to_html_crossref.rb
  • rdoc/markup/to_html_snippet.rb
  • rdoc/markup/to_joined_paragraph.rb
  • rdoc/markup/to_label.rb
  • rdoc/markup/to_markdown.rb
  • rdoc/markup/to_rdoc.rb
  • rdoc/markup/to_table_of_contents.rb
  • rdoc/markup/to_test.rb
  • rdoc/markup/to_tt_only.rb
  • rdoc/markup/verbatim.rb
  • rdoc/meta_method.rb
  • rdoc/method_attr.rb
  • rdoc/normal_class.rb
  • rdoc/normal_module.rb
  • rdoc/options.rb
  • rdoc/parser.rb
  • rdoc/parser/c.rb
  • rdoc/parser/changelog.rb
  • rdoc/parser/markdown.rb
  • rdoc/parser/rd.rb
  • rdoc/parser/ruby.rb
  • rdoc/parser/ruby_tools.rb
  • rdoc/parser/simple.rb
  • rdoc/parser/text.rb
  • rdoc/rd.rb
  • rdoc/rd/block_parser.rb
  • rdoc/rd/inline.rb
  • rdoc/rd/inline_parser.rb
  • rdoc/rdoc.rb
  • rdoc/require.rb
  • rdoc/ri.rb
  • rdoc/ri/driver.rb
  • rdoc/ri/formatter.rb
  • rdoc/ri/paths.rb
  • rdoc/ri/store.rb
  • rdoc/ruby_lex.rb
  • rdoc/ruby_token.rb
  • rdoc/rubygems_hook.rb
  • rdoc/servlet.rb
  • rdoc/single_class.rb
  • rdoc/stats.rb
  • rdoc/stats/normal.rb
  • rdoc/stats/quiet.rb
  • rdoc/stats/verbose.rb
  • rdoc/store.rb
  • rdoc/task.rb
  • rdoc/test_case.rb
  • rdoc/text.rb
  • rdoc/token_stream.rb
  • rdoc/tom_doc.rb
  • rdoc/top_level.rb

Class/Module Index [+]

Quicksearch

RDoc

RDoc produces documentation for Ruby source files by parsing the source and extracting the definition for classes, modules, methods, includes and requires. It associates these with optional documentation contained in an immediately preceding comment block then renders the result using an output formatter.

For a simple introduction to writing or generating documentation using RDoc see the README.

Roadmap

If you think you found a bug in RDoc see Bugs at DEVELOPERS

If you want to use RDoc to create documentation for your Ruby source files, see RDoc::Markup and refer to rdoc --help for command line usage.

If you want to set the default markup format see Supported Formats at RDoc::Markup

If you want to store rdoc configuration in your gem (such as the default markup format) see Saved Options at RDoc::Options

If you want to write documentation for Ruby files see RDoc::Parser::Ruby

If you want to write documentation for extensions written in C see RDoc::Parser::C

If you want to generate documentation using rake see RDoc::Task.

If you want to drive RDoc programmatically, see RDoc::RDoc.

If you want to use the library to format text blocks into HTML or other formats, look at RDoc::Markup.

If you want to make an RDoc plugin such as a generator or directive handler see RDoc::RDoc.

If you want to write your own output generator see RDoc::Generator.

If you want an overview of how RDoc works see Bugs at DEVELOPERS

Credits

RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.

Dave Thomas <dave@pragmaticprogrammer.com> is the original author of RDoc.

  • The Ruby parser in rdoc/parse.rb is based heavily on the outstanding work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby parser for irb and the rtags package.

Constants

ATTR_MODIFIERS

RDoc modifiers for attributes

CLASS_MODIFIERS

RDoc modifiers for classes

CONSTANT_MODIFIERS

RDoc modifiers for constants

DOT_DOC_FILENAME

Name of the dotfile that contains the description of files to be processed in the current directory

GENERAL_MODIFIERS

General RDoc modifiers

KNOWN_CLASSES

Ruby’s built-in classes, modules and exceptions

METHOD_MODIFIERS

RDoc modifiers for methods

VERSION

RDoc version you are using

VISIBILITIES

Method visibilities

Public Class Methods

load_yaml() click to toggle source

Loads the best available YAML library.

 
               # File rdoc.rb, line 109
def self.load_yaml
  begin
    gem 'psych'
  rescue Gem::LoadError
  end

  begin
    require 'psych'
  rescue ::LoadError
  ensure
    require 'yaml'
  end
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

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 bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus