Rdoc 3.7 Released

Ruby
1

rdoc version 3.7 has been released!

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.7 / 2011-06-27

  • Minor enhancements
    • New directive :category: which allows methods to be grouped into
      sections
      more cleanly. See RDoc::Markup for details.
    • Document-class for RDoc::Parser::C now supports Foo::CONST as well
      as
      CONST.
    • ri method output is now a comma-separated list when displayed
      interactively. Pull Request #39 by Benoit D…
    • RDoc::ClassModule#merge now prefers the argument’s information over
      the
      receiver’s (it now behaves like Hash#merge! instead of a backwards
      Hash#merge!).
    • RDoc::Markup#convert now accepts an RDoc::Markup::Document instance
    • RDoc now owns the code for generating RDoc and ri data when gems
      install
    • Added RDoc::RDoc::reset
    • Added RDoc::CodeObject#file_name
  • Bug fixes
    • ri no longer crashes when attempting to complete a plain [.
    • ri data now tracks which file information came from so it can
      process
      removals and changes to:
      • Classes and Modules
      • Methods
      • Attributes
      • Includes
      • Constants
        You will need to rebuild your ri data for it to update properly.
        Issue
        #21 by Sven Riedel
    • Signal and SignalException no longer clobber each other
    • RDoc::Parser::C no longer creates classes when processing aliases.
    • RDoc::Text#strip_stars handles Document-method for methods with =, !
      and ?
      now.
    • RDoc::Parser::C now allows .cpp files to be used with the “in”
      comment on
      rb_define_method. Bug #35 by Hanmac.
    • RDoc::Parser::Ruby no longer eats content when =begin/=end
      documentation
      blocks are followed by a documentable item. Issue #41 by mfn.
    • RDoc::Markup::Formatter and subclasses now allow an optional
      +markup+
      parameter for adding custom markup. The example in
      RDoc::Markup::Formatter will now work. Issue #38 by tsilen.
    • RDoc::Parser::C can now distinguish between class methods and
      instance
      methods in Document-method. Issue #36 by Vincent Batts.
    • RDoc now encodes file names in the output encoding. Issue #33 by
      Perry
      Smith.
    • ri data generation for method aliases no longer duplicates the class
      in
      #full_name
2

Eric H. [email protected] wrote:

You will need to rebuild your ri data for it to update properly.
Issue #21 by Sven Riedel

Could you give an example of what to say on the command-line to make
that happen? Do you mean something like rdoc --all --ri? Thx - m.

3

On Jun 29, 2011, at 10:01 AM, Matt N. wrote:

Eric H. [email protected] wrote:

You will need to rebuild your ri data for it to update properly.
Issue #21 by Sven Riedel

Could you give an example of what to say on the command-line to make
that happen? Do you mean something like rdoc --all --ri? Thx - m.

Regular users (via gem install) don’t have this problem since the
documentation is built from scratch at install time.

AFAIK the only users who update ri data are those building and
installing ruby trunk. For those users rm .ext/rdoc will solve the
problem.

If you are updating ri data atop the same dir rm ri_dir will fix the
problem.