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

Changelog History
Page 5

  • v3.6.1 Changes

    May 15, 2011
    • ๐Ÿ› Bug fixes
      • Fix infinite loop created when re-encountering BasicObject.
      • RDoc::Context#each_ancestor is now provided for duck-typing.
      • rb_path2class() can now be used to discover the parent class in rb_define_class_under.
  • v3.6 Changes

    May 13, 2011
    • Major Enhancements
      • Interactive ri is now the default when no names are given.
    • Minor Enhancements
      • RDoc::RDoc#generate was added to allow multiple generators to be used with a set of parsed file info.
      • RDoc::Options#finish can be called multiple times now.
      • ri -i only shows one level of namespace when completing class names.
      • Added ri --list for explicit listing. ri -l F G will list all classes or modules starting with F or G
    • ๐Ÿ› Bug fixes
      • Remove windows-specific test for test_check_files, it is too hard to do. Ruby commit r30811 by Usaku Nakamura.
      • Remove unnecessary (and wrong) platform-dependent hacks. Ruby commit r30829 by Usaku Nakamura.
      • Completing via Array#[ in ri -i no longer crashes. Ruby Bug #3167
      • Completing IO::o in ri -i now returns results. Ruby Bug #3167
      • RDoc::Parser::C ignores prototypes better. Pull Request #34 by Pete Higgins.
      • private_class_method and public_class_method are now parsed correctly for inherited methods. Issue #16 by gitsucks.
      • The doc directive now forces documentation even when the method is marked private or protected.
  • v3.5.3 Changes

    February 06, 2010
    • ๐Ÿ› Bug fixes
      • When including a file perform a lossy force-transcoding to the output encoding instead of crashing to preserve as much content as possible. Ruby Bug #4376 by Yui NARUSE.
      • Work around inconsistent encoding result from String#sub!, String#gsub!. Related to Ruby Bug #4376.
      • Work around inconsistent encoding result from String#[]=. Related to Ruby Bug #4376.
      • When Darkfish fails the file being generated is now reported.
  • v3.5.2 Changes

    February 04, 2010
    • ๐Ÿ—„ Deprecations

      • RDoc::Context::Section#sequence is now deprecated. Use RDoc::Context::Section#aref instead.
    • ๐Ÿ› Bug fixes

      • Fixed syntax highlighting CSS class generation. Reported by Daniel Bretoi.
      • Fixed ri for methods with aliases. Pull Request #15 by Sven Riedel.
      • Added windows-specific test for test_check_files.
      • Darkfish now supports sections. Template and generator author see RDoc::Context#each_section to add section support. RubyForge Bug #26883 by Jeff Hodges.
      • Fixed post-install message for Ruby 1.9.2 users.
      • Set required ruby version to >= 1.8.7.
  • v3.5.1 Changes

    January 30, 2010
    • ๐Ÿ› Bug fixes
      • Fixed some typos. Pull request #13 by R.T. Lechow.
      • Ensure an RDoc::Stats is created in #parse_files. Fixes documentation for railties which has no files. Reported by Aaron Patterson
  • v3.5 Changes

    January 29, 2010
    • Minor enhancements
      • RDoc::Parser::C looks for rb_scan_args and fills in RDoc::AnyMethod#params appropriately. This may provide useful information if the author did not provide a call-seq.
      • RDoc::Parser::C now records the function name for methods implemented in C.
      • RDoc now records file and byte offset information for methods.
    • ๐Ÿ› Bug fixes
      • Locations of module aliases are now recorded.
      • RDoc::Parser::C finds method bodies better now.
      • Fixed further locations where output encoding was not preserved. Bug #11 by Vรญt Ondruch, RubyForge bug #28791 by Dzmitry Prakapenka.
      • Fixed display of numeric lists on the index page and file pages. Bug #12 by tobijk.
      • Skip TestRDocOptions#test_check_files on windows until a windows-specific test can be created. RubyForge bug #28821 by Usaku Nakamura.
      • Fixed line-height of headings in method and alias descriptions. RubyForge Bug #2770 by Adam Avilla
      • Relaxed RDoc::Parser::Ruby#remove_private_comments to consume more dashes as older versions once did. Bug #7 by Claus Folke Brobak.
  • v3.4 Changes

    January 06, 2010
    • Minor enhancements
      • RDoc::RDoc#document may now be called with an RDoc::Options instance.
    • ๐Ÿ› Bug fixes
      • Added skips to Encoding tests running on 1.8.
      • Fixed warnings
  • v3.3 Changes

    January 03, 2010
    • Minor enhancements

      • The coverage report can now report undocumented method parameters including methods defined in C.

      rdoc -C gives a standard report, rdoc -C1 includes method parameters. Method parameters are considered documented if they're marked-up with +, or .

      • The C parser now uses *args instead of ... if no call-seq was provided to give names to the arguments.
    • ๐Ÿ› Bug fixes

      • The C parser now records the file location of aliases, attributes, constants and methods allowing -C to work on C files.
      • Darkfish now handles dots in call-seq allowing ary.insert(index, obj...) to display correctly. Patch #6 by KUBO Takehiro.
      • Improved processing of meta-programmed methods when followed by unparseable syntax. RubyForge patch #28653 by Aidan Cully.
      • rdoc now touches the flag file when it create the output directory. Prevents the "isn't an RDoc directory" error if rdoc crashes.
      • RDoc now properly converts to the expected output encoding. RubyForge bug #28791 by Dzmitry Prakapenka.
      • Restored parsing of block comments. RubyForge bug #28668 by Stefano Crocco.
      • Metaprogrammed methods defined with blocks no longer confuse the ruby parser. RubyForge bug #28370 by Erik Hollensbe.
      • ri no longer displays all methods in the inheritance chain.
  • v3.2 Changes

    December 29, 2010
    • Minor enhancements
      • RDoc generator authors may now suppress updating the output dir (creating a created.rid file) by setting RDoc::Options#update_output_dir to false.
      • RDoc::Task has been refactored to ease creating subclasses.
    • ๐Ÿ› Bug fixes
      • RDoc's gitignore now ignores .DS_Store files. Pull Request #3 by Shane Becker.
  • v3.1 Changes

    December 28, 2010

    ๐Ÿš€ RDoc has moved to github. Releases after 3.1 reference github unless otherwise noted.

    • Minor enhancements
      • RDoc::Task now features a #generator option to choose an alternate generator. Pull Request #2 by Erik Hollensbe.
      • Enhanced test for RDoc::Parser::binary? RubyForge patch #28538 by Eito Katagiri.
      • Generator list in --help is no longer static. Generator description comes from the generator's DESCRIPTION constant.
      • Documentation summary is now displayed with dynamic width.
    • ๐Ÿ› Bug fixes
      • Strip encoding comment from input to avoid overriding file comment. RubyForge Bug #22113 by James Gray.
      • Restore call-seq parsing behavior when the call-seq is the only comment. RubyForge Bug #26290 by Sylvain Joyeux.
      • Coverage report no longer crashes for constant aliases. Pull Request #1 by Andy Lindeman.
      • RDoc no longer loses ghost methods when followed by certain tokens. RubyForge bug #27793 by Aaron Patterson.
      • RDoc no longer crashes in ri if HOME is not set. Ruby Bug #4202 by Shyouhei Urabe.
      • ri no longer crashes with HTML format output. RubyForge bug #28675 by 7rans.
      • RDoc::Markup::ToHtml#gen_url now initializes #from_path to ''. Additionally, #from_path is now settable. RubyForge bug #27838 by Claus Folke Brobak.
      • Comments in the C parser are now normalized before being combined. RubyForge patch #28646 by Sven Herzberg.
      • RDoc::Parser::C no longer requires a comment and finds more method bodies. RubyForge patch #28643 by Sven Herzberg.
      • Darkfish now has a "Class/Module Index" instead of a "Class Index". RubyForge patch #28364 by James Tucker.
      • RDoc::Parser::Ruby now parses negative numbers correctly. RubyForge patch #28544 by Eito Katagiri.