RDoc

RDoc is made of two major parts.

One is rdoc, an utility for generating HTML documentation. The second is ri, a tool for creating documentation for the Ruby command-line interface.

To be able to properly use RDoc, the developer must change the way he adds comments to his source code.

RDoc uses a specific source code comments structure, so they can easily be extracted and help populate the documentation site.

RDoc's comment structure is extremely successful, being used by many similar documentation generators created for other programming languages.

What is new in this release:

• RDoc can now produce translation files for use with gettext.

What is new in version 4.2.0:

• RDoc can now produce translation files for use with gettext.

What is new in version 4.1.0:

• Improved accessibility of HTML output.
• The look of RDoc has been updated.

What is new in version 4.0.0:

• Added Markdown as a supported format.
• ri can now show pages (README, etc.).
• Removed global state from RDoc. RDoc::Store holds the documentation tree and connects the driver to the parsers and generator.

What is new in version 3.12:

• Minor enhancements:
• Added DEVELOPERS document which contains an overview of how RDoc works and how to add new features to RDoc.
• Improved title for HTML output to include --title in the title element.
• rdoc --pipe now understands --markup.
• RDoc now supports irc-scheme hyperlinks.
• Bug fixes:
• Fixed title on HTML output for pages.
• Fixed parsing of non-indented HEREDOC.
• Fixed parsing of %w[] and other % literals.
• Fixed arrow replacement in HTML output munging the spaceship operator.
• Verbatim sections with ERB that match the ruby code whitelist are no longer syntax-highlighted.
• Line endings on windows are normalized immediately after reading with binmode.
• RDoc better understands directives for comments. Comment directives can now be found anywhere in multi-line comments.
• Tidy links to methods show the label again.
• RDoc::Parser::C can now find comments directly above rb_define_class_under.
• In rdoc, backspace and ansi formatters, labels and notes without bodies are now shown.
• In rdoc, backspace and ansi formatters, whitespace between label or note and the colon is now stripped.

What is new in version 3.11:

• Bug fixes:
• Avoid parsing TAGS files included in gems.

What is new in version 3.9.2:

• Bug fix:
• Loosened TIDYLINK regexp to allow any content in the link section like: <tt>{foo}[rdoc-ref:SomeClass]</tt>
• In HTML output headings are capped at <tt><h6></tt> again.

What is new in version 3.9.1:

• Bug fixes:
• Fix RDoc::Markup parser for a header followed by a non-text token.
• Fix RDoc::Markup::ToHtmlCrossref#gen_url for non-<tt>rdoc-ref</tt> links.
• Fix bug report URL when rdoc crashes.

What is new in version 3.8:

• Minor enhancements:
• RDoc::Parser::C can now discover methods on ENV and ARGF.
• RDoc::Parser::C now knows about rb_cSocket and rb_mDL.
• Bug fixes:
• Updating Object in an ri data store with new data now removes methods, includes, constants and aliases.

What is new in version 3.7:

• Minor enhancements:
• New directive :category: which allows methods to be grouped into sections more cleanly. See RDoc::Markup for details.
• Document-class for RDoc::Parser::C now supports Foo::CONST as well as CONST.
• ri method output is now a comma-separated list when displayed interactively.
• RDoc::ClassModule#merge now prefers the argument's information over the receiver's (it now behaves like Hash#merge! instead of a backwards Hash#merge!).
• RDoc::Markup#convert now accepts an RDoc::Markup::Document instance
• RDoc now owns the code for generating RDoc and ri data when gems install
• Added RDoc::RDoc::reset
• Added RDoc::CodeObject#file_name
• Bug fixes:
• ri no longer crashes when attempting to complete a plain
• RDoc::Parser::Ruby no longer eats content when =begin/=end documentation blocks are followed by a documentable item. Issue #41 by mfn.
• RDoc::Markup::Formatter and subclasses now allow an optional +markup+ parameter for adding custom markup. The example in RDoc::Markup::Formatter will now work.
• RDoc::Parser::C can now distinguish between class methods and instance methods in Document-method.
• RDoc now encodes file names in the output encoding.
• ri data generation for method aliases no longer duplicates the class in #full_name