Release Name: 2.5.1
Notes:
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.1 / 2010-04-?
*NOTE*:
RDoc 2.5 did not save method parameters, so you should upgrade your rdoc-data
gem to a version > 2.5.1.
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.
* 1 Minor Enhancement
* RDoc::Parser::C now supports the include directive for classes and
modules.
* N Bug Fixes
* RDoc::AnyMethod params now get saved in ri data.
* ri now displays method arguments correctly.
* RDoc::Markup::Parser allows no space between = and header text like rdoc
2.4 and earlier.
* RDoc::Parser::C's "in" directive now looks in the current directory.
* RDoc::Task's rerdoc task no longer deletes the doc directory twice.
* rdoc --force-update now works correctly. Patch by Nobu Nokada
|