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

Changelog History
Page 6

  • v3.0.1 Changes

    December 19, 2010
    • ๐Ÿ› Bug fix
      • RDoc no longer has a Perl parser.
  • v3.0 Changes

    December 19, 2010

    Special thanks to Thierry Lambert for massive improvements to RDoc.

    • Major enhancements
      • Ruby 1.8.6 is no longer supported by RDoc.
      • RDoc now converts input files to a single encoding specified by --encoding. See RDoc::RDoc and RDoc::Options#encoding. --encoding is now preferred over --charset
      • RDoc now supports a --coverage-report flag (also -C and --dcov) that outputs a report on items lacking documentation.
      • Templates (rdoc -T) are now checked for existence in RDoc::Options. Generator authors can now use RDoc::Options#template_dir which is the full path to the template directory.
      • Added support for class aliases. Patch by Thierry Lambert.
      • Improved merging of classes and modules across multiple files including more accurate documentation statistics. Patch by Thierry Lambert.
      • Improved handling of method aliases. Patch by Thierry Lambert.
      • Improved handling of visibility of RDoc code objects. Patch by Thierry Lambert.
      • RDoc::Attr#type is now RDoc::Attr#definition. Patch by Thierry Lambert.
      • Removed TimeConstantMethods
      • RDoc now calls ::new instead of ::for on generators.
    • Minor enhancements
      • Added rdoc arguments --dry-run, --all, --visibility, --force-output, --hyperlink-all. Patch by Thierry Lambert.
      • RDoc::Markup::FormatterTestCase has been expanded. Patch by Thierry Lambert.
      • RDoc::Markup::TextFormatterTestCase has been extracted from RDoc tests. Patch by Thierry Lambert.
      • Various RDoc::Parser::Ruby enhancements. Patch by Thierry Lambert.
      • Various RDoc::Markup::Parser enhancements. Patch by Thierry Lambert.
      • RDoc::Parser::binary? is more robust now that it uses Encoding.
      • Deprecated rdoc arguments are now explicitly mentioned in rdoc command output. Patch by Thierry Lambert.
      • Constant values are formatted more accurately. Patch by Thierry Lambert.
      • Enhanced call-seq parsing in RDoc::Parser::C. Patch by Thierry Lambert.
      • RDoc no longer uses kw, cmt, re or str classes for embedded source code snippets. Patch by Thierry Lambert.
      • RDoc directives may now be escaped with a leading '\'. Patch by Thierry Lambert.
      • RDoc note lists (label::) now generate a table with class "rdoc-list". Patch by Thierry Lambert.
      • RDoc markup documentation has been moved to RDoc::Markup including notes on how to document source code.
      • An RDoc::Require is now always listed at the file level. Patch by Thierry Lambert.
      • RDoc::CodeObjects now know which file they were defined in.
      • RDoc::Options calls ::setup_options on the generator class specified by --format. See RDoc::Options::setup_generator.
      • rdoc gives an error when multiple formats are given.
      • Files with erb inside will no longer trip RDoc::Parser::binary?
      • Last --title wins. Patch by Thierry Lambert.
      • Better block params handling. Patch by Thierry Lambert.
      • Moved rdoc/tokenstream.rb to rdoc/token_stream.rb.
      • Moved rdoc/markup/preprocess.rb to rdoc/markup/pre_process.rb.
      • Removed "':' not followed by operator or identifier" warning for new Hash syntax.
      • rb_attr() is now supported for attributes.
      • RDoc::Parser::C now supports yields, doc, and args directives like RDoc::Parser::Ruby.
      • Moved RDoc::Parser::PerlPOD to the rdoc-perl_pod gem.
    • ๐Ÿ› Bug fixes
      • RDoc::Generator tests no longer require any installed RDoc on Ruby 1.9
      • Load existing cache before generating ri. Ruby r27749 by NAKAMURA Usaku.
      • RDoc now handles BOM. Ruby r28062 by Nobuyoshi Nakada.
      • Use proper XML encoding for darkfish classpage. Ruby r28083 by NARUSE, Yui.
      • Fix ri output when special characters are inside html tags. Patch by Tomo Kazahaya, Ruby Bug #3512.
      • Don't bother checking if the pager exists, it's already done. Ruby r28842 by NAKAMURA Usaku.
      • RDoc::Parser::Ruby now ignores non-constant-named singleton classes. Ruby r29140 by Nobuyoshi Nakada. Ruby Bug #3759.
      • RDoc::Parser::Ruby call args no longer include assignment. Ruby r29141 by Nobuyoshi Nakada. Ruby Bug #3759
      • Handle $HOME being unset in ri. Ruby r29272 by Nobuyoshi Nakada.
      • uniq ancestors and modules too. Ruby r29312 by Nobuyoshi Nakada.
      • RDoc now knows about Encoding by default. Ruby r29356 by Nobuyoshi Nakada.
      • ri now defaults to the backspace formatter when piped. Use RI environment variable or options to override. Ruby r28455 by Yusuke Endoh.
      • send and friends no longer get their underscores removed. Patch by Thierry Lambert.
      • The C parser now makes new public when promoting initialize.
      • Fix crash in #markup_code for TkUnknownChar.
      • Fix crash in RDoc::Parser::C when aliasing methods with Regexp special characters.
      • Fix crash when various operators are used as a name as in alias * compose.
      • Fix warning with some dynamic use of attr_*
      • Methods added to true, false and nil are now documented.
      • Remove warning for methods defined on globals.
  • v2.5.11 Changes

    August 20, 2010
    • Minor Enhancements
      • Alias comments are now discovered by the C parser. Reported by Jeremy Evans.
      • Removed --all option which is unused in RDoc. Use the nodoc or stopdoc/startdoc directives to suppress documentation instead.
  • v2.5.10 Changes

    August 17, 2010
    • Minor Enhancements

      • Support rb_singleton_class(). Reported by Jeremy Evans.
      • Support rb_define_private_method() on rb_singleton_class(). Reported by Jeremy Evans.
    • ๐Ÿ› Bug Fixes

      • Treat non-ASCII RDoc files as text. Bug #28391 by Kouhei Sutou.
      • Fix potential test failures due to ivar collision. Bug #28390 by Kouhei Sutou.
      • Added duck-typed #aref for RDoc::Attr to RDoc::AnyMethod. Bug #28375 by Erik Hollensbe
      • Fixed method references in HTML output when show_hash is false.
      • Fixed comments with '.' in call-seq in C sources. Reported by Jeremy Evans.
      • RDoc now understands singleton aliases. Reported by Jeremy Evans.
  • v2.5.9 Changes

    July 06, 2010
    • ๐Ÿ› Bug Fixes
      • Look up pager correctly.
      • Fixed handling of bullets in verbatim sections. Partial patch by Juha-Jarmo Heinonen.
  • v2.5.8 Changes

    April 27, 2010


    โฌ†๏ธ RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data gem to a version >= 2.5.3.

    To have ri data for core and stdlib you'll need to:

    gem install rdoc-data

    then run:

    rdoc-data --install

    To have ri data for you gems you'll also need to run:

    gem rdoc --all --overwrite

    If you don't want to rebuild the rdoc for gem server, add --no-rdoc.

    • ๐Ÿ› Bug Fixes
      • ri no longer complains about nonexistent pagers.
      • Fixed failing test
  • v2.5.7 Changes

    April 22, 2010
    • Minor Enhancements
      • Unrecognized RDoc directives can now be registered by a plugin for handling. See RDoc::Markup::PreProcess.
      • Added RDoc::Markup::Raw to allow other markup engines to dump raw content into RDoc.
    • ๐Ÿ› Bug Fixes
      • rdoc -p no longer means --pipe if files are also given.
      • RDoc now knows about BasicObject by default. Ruby Bug #1318 by Ambrus Zsbรกn
  • v2.5.6 Changes

    April 22, 2010
    • Minor Enhancements

      • Unrecognized RDoc directives are added as metadata to the object they get attached to.

      ## # :my_new_directive: my cool value

      Results in a 'my_new_directive' metadata key with value 'my cool value' on the RDoc::CodeObject it is for

    • ๐Ÿ› Bug Fixes

      • RDoc no longer prints out "invalid options:" when there were no invalid options.
      • Fixed link size on Darkfish file pages
  • v2.5.5 Changes

    April 19, 2010
    • 1 Minor Enhancement
      • Use #binread in RDoc::Markup::PreProcess. Patch from ruby trunk.
    • ๐Ÿ›  3 Bug Fixes
      • Fixed indentation of method-description lists in Darkfish. Bug #28081 by Theresa Dwinnell.
      • Fixed loading RDoc::AnyMethod aliases to no longer infinitely loop. Bug #28107 by Sven Riedel
      • Fixed handling of ignored invalid options to continue after the invalid option.
  • v2.5.4 Changes

    April 18, 2010
    • 2 Minor Enhancements
      • Methods will now be cross-referenced when preceded with ::. Ruby Bug #3169 by Marc-Andre Lafortune.
      • Methods now have human readable fragment identifiers for HTML output. (#method-i-gsub vs #M000005). Ruby Bug #3023 by Marc-Andre Lafortune.
    • ๐Ÿ›  1 Bug Fixes
      • RDoc::Parser::Ruby now handles while begin a; b end # .... Ruby Bug #3160 by Yusuke Endoh.