RDoc 2.1.0

Eric Hodel | Mon, 21 Jul 2008 05:25:39 GMT

Posted in RDoc, Software

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 the RDoc 1.0.1. Command-line tools are largely unaffected, but internal APIs may shift rapidly.

• 3 Major Enhancements:
  • RDoc now knows about meta-programmed methods, see RDoc::Parser::Ruby
  • Reorganized parsers under RDoc::Parser base class
  • ri now walks the ancestors of a class looking for a method e.g. ri File#read displays documentation for IO#read (may require regeneration of ri data)
• 5 Minor Enhancements:
  • Allow links to files
  • Default options now taken from RDOCOPT environment variable
  • Class method documentation can be found at toplevel now (def X.foo)
  • Allow HTML templates distributed as gems to be loaded with the -T option, just like the standard templates in rdoc/generator/html (so an HTML template lib/new_template.rb in a gem can be used with rdoc -T new_template)
  • `rdoc -v` prints out files, classes, modules and methods as it goes
• 11 Bug Fixes:
  • `ri Foo.bar` now looks for class methods also
  • Sections work in the default template again
  • Doesn’t warn about :foo:: list item being an unrecognized directive
  • RDoc no longer converts characters inside tt tags
  • Fixed “unitialized constant RDoc::Markup::ToHtml::HTML”
  • Fixed generation of relative links
  • Fixed various diagram generation issues
  • Fixed templates broken by switch to erb
  • Fixed issue with <!- -> style comments
  • Lowercase words are no longer rdoc’d as methods without leading #, as described in the documentation
  • RDoc now correctly sets superclasses if they were originally unknown

Comments