RDoc 3.6

drbrain | Sat, 14 May 2011 00:29:28 GMT

Posted in ,

RDoc produces HTML and command-line documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying online documentation.

See RDoc for a description of RDoc’s markup and basic use.

Changes:

3.6 / 2011-05-13

  • 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.

comments

Comments RSS FEED

Is rdoc-data still relevant? rdoc-data —install doesn’t seem to work with 1.9.2-p180 under rvm but I was able to get it to work (quote/unquote) by symlinking the data/1.9.1 directory to 1.9.2.

zhando said about 17 hours later

Only if you are still using Ruby 1.8.7 or Ruby 1.9.1. Ruby 1.9.2 creates ri data using the modern format so there’s no need to install rdoc-data.

There’s also no need to re-install rdoc-data if you’ve done so before, once is enough.

Eric Hodel said about 20 hours later

Ok I didn’t know about the —docs flag in rvm.

If you don’t have core and stdlib ri pages in your 1.9.2 implementation under rvm (like I didn’t for some reason) then it’s just a

rvm —docs install 1.9.2

away…

zhando said 4 days later

Comments are disabled