All Versions
Latest Version
Avg Release Cycle
184 days
Latest Release
462 days ago

Changelog History
Page 4

  • v3.11

    October 17, 2011
    • 🐛 Bug fixes
      • Avoid parsing TAGS files included in gems. Issue #81 by Santiago Pastorino.
  • v3.10

    October 08, 2011
    • Major enhancements

      • RDoc HTML output has been improved:
      • The search from Володя Колесников's (Vladimir Kolesnikov) SDoc has been integrated.

      The search index generation is a reusable component through RDoc::Generator::JsonIndex

      • The table of contents is now a separate page and now shows links to headings and sections inside a page or class.
      • Class pages no longer show the namespace and no longer have file info pages.
      • HTML output is HTML 5.
      • Static files can be copied into RDoc using --copy-files
      • RDoc supports additional documentation formats:
      • TomDoc 1.0.0-rc1
      • RD format

      The default markup can be set via the --markup option.

      The format of documentation in a particular file can be specified by the +:markup:+ directive. If the +:markup:+ directive is in the first comment it is used as the default for the entire file. For other comments it overrides the default markup format.

      The markup format can be set for rake tasks using RDoc::Task#markup

      • RDoc can save and load an options file.

      To create an options file that defaults to using TomDoc markup run:

      rdoc --markup tomdoc --write-options

      This will create a .rdoc_options file. Check it in to your VCS and package it with your gem. RDoc will automatically load this file and combine it with the user's options.

      Some options are not saved. See RDoc::Options@Saved+Options for full details.

    • Minor enhancements

      • RDoc autoloads everything. You only need to require 'rdoc' now.
      • HTML headings now have ids matching their titles.

      = Hello!

      Is rendered as


      • Labels for classes or methods can be linked-to by adding an @ following the class or method reference. For example, RDoc::Markup@Links

      See RDoc::Markup@Links for further details.

      • For HTML output RDoc uses +SomeClass.method_name+ and +SomeClass#method_name+ for remote methods and attributes and +::method_name+ and +#method_name+ for local methods.
      • RDoc makes an effort to syntax-highlight ruby code in verbatim sections. See RDoc::Markup@Paragraphs+and+Verbatim
      • Added RDoc::TopLevel#text? and RDoc::Parser::Text to indicate a parsed file contains no ruby constructs.
      • Added rdoc-label link scheme which allows bidirectional links. See RDoc::Markup for details.
      • Image paths at HTTPS URLs will now be turned into ++ tags. Pull Request #60 by James Mead
      • Added RDoc::Comment which encapsulates comment-handling functionality.
      • Added RDoc::Markup::PreProcess::post_process to allow arbitrary comment munging.
      • RDoc::RDoc::current is set for the entire RDoc run.
      • Split rdoc/markup/inline into individual files for its component classes.
      • Moved token stream HTML markup out of RDoc::AnyMethod#markup_code into RDoc::TokenStream::to_html
      • "Top" link in section headers is no longer inside the heading element.
      • RDoc avoids printing some warnings unless run with rdoc --verbose. For Rails issue #1646.
      • Finishing a paragraph with two or more spaces will result in a line break. This feature is experimental and may be modified or removed.
    • 🐛 Bug fixes

      • Markup defined by RDoc::Markup#add_special inside a is no longer converted.
      • Performance of RDoc::RubyLex has been improved. Ruby Bug #5202 by Ryan Melton.
      • Add US-ASCII magic comments to work with ruby -Ku. Issue #63 by Travis D. Warlick, Jr.
      • Clicking a link in the method description now works. Issue #61 by Alan Hogan.
      • Fixed RDoc::Markup::Parser for CRLF line endings. Issue #67 by Marvin Gülker.
      • Fixed lexing of percent strings like %r{#}. Issue #68 by eclectic923.
      • The C parser now understands classes defined with +rb_struct_define_without_accessor+ (like Range). Pull Request #73 by Dan Bernier
      • Fixed lexing of a b <<-HEREDOC. Issue #75 by John Mair.
      • Added LEGAL.rdoc with references to licenses in other files. Issue #78 by Dmitry Jemerov.
      • Block parameters are displayed in Darkfish output again. Issue #76 by Andrea Singh.
      • The method parameter coverage report no longer includes parameter default values. Issue #77 by Jake Goulding.
      • The module for an include is not looked up until parsed all the files are parsed. Unless your project includes nonexistent modules this avoids worst-case behavior (O(n!)) of RDoc::Include#module.
  • v3.9.5

    February 05, 2013
    • 🐛 Bug fixes
      • Fixed an XSS exploit in darkfish.js. This could lead to cookie disclosure to third parties. See CVE-2013-0256.rdoc for full details including a patch you can apply to generated RDoc documentation.
  • v3.9.4

    August 26, 2011
    • 🐛 Bug fixes
      • Applied typo and grammar fixes from Luke Gruber. Ruby bug #5203
  • v3.9.3

    August 23, 2011
    • 🐛 Bug fixes
      • Add US-ASCII magic comments to work with ruby -Ku. Issue #63 by Travis D. Warlick, Jr.
      • Image paths at HTTPS URLs are now turned into ++ tags. Pull Request #60 by James Mead
      • Markup defined by RDoc::Markup#add_special inside a is no longer converted.
  • v3.9.2

    August 11, 2011
    • 🐛 Bug fix
      • Loosened TIDYLINK regexp to allow any content in the link section like: {foo}[rdoc-ref:SomeClass]
      • In HTML output headings are capped at again
  • v3.9.1

    July 31, 2011
    • 🐛 Bug fixes
      • Fix RDoc::Markup parser for a header followed by a non-text token. Issue #56 by Adam Tait
      • Fix RDoc::Markup::ToHtmlCrossref#gen_url for non-rdoc-ref links.
      • Fix bug report URL when rdoc crashes.
  • v3.9

    July 30, 2011
    • Minor enhancements
      • RDoc::Parser::C now supports :doc: and :nodoc: for class comments
      • Added the rdoc-ref: link scheme which links to a named reference. rdoc-ref: can resolve references to classes, modules, methods, files, etc. This can be used to create cross-generator named links unlike the link: scheme which is dependent upon the exact file name. Issue #53 by Simon Chiang
      • Pulled RDoc::CrossReference out of RDoc::Markup::ToHtmlCrossref. Cross-references can now be created easily for non-HTML formatters.
    • 🐛 Bug fixes
      • ri [] and other special methods now work properly. Issue #52 by ddebernardy.
      • ri now has space between class comments from multiple files.
      • :stopdoc: no longer creates Object references. Issue #55 by Simon Chiang
      • :nodoc: works on class aliases now. Issue #51 by Steven G. Harms
      • Remove tokenizer restriction on header lengths for verbatim sections. Issue #49 by trans
  • v3.8

    June 29, 2011
    • 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.
  • v3.7

    June 27, 2011
    • 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. Pull Request #39 by Benoit Daloze.
      • 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 [.
      • ri data now tracks which file information came from so it can process removals and changes to:
      • Classes and Modules
      • Methods
      • Attributes
      • Includes
      • Constants You will need to rebuild your ri data for it to update properly. Issue #21 by Sven Riedel
      • Signal and SignalException no longer clobber each other
      • RDoc::Parser::C no longer creates classes when processing aliases.
      • RDoc::Text#strip_stars handles Document-method for methods with =, ! and ? now.
      • RDoc::Parser::C now allows .cpp files to be used with the "in" comment on rb_define_method. Bug #35 by Hanmac.
      • 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. Issue #38 by tsilen.
      • RDoc::Parser::C can now distinguish between class methods and instance methods in Document-method. Issue #36 by Vincent Batts.
      • RDoc now encodes file names in the output encoding. Issue #33 by Perry Smith.
      • ri data generation for method aliases no longer duplicates the class in #full_name