Files | Admin


Release Name: 2.5.7

RDoc is an application that produces documentation for one or more Ruby source
files.  RDoc includes the +rdoc+ and +ri+ tools for generating and displaying
online documentation.

At this point in time, RDoc 2.x is a work in progress and may incur further
API changes beyond what has been made to RDoc 1.0.1.  Command-line tools are
largely unaffected, but internal APIs may shift rapidly.

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

Changes: === 2.5.7 / 2010-04-22 *NOTE*: 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. * 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