|
This post originated from an RSS feed registered with Ruby Buzz
by Eric Hodel.
|
Original Post: RDoc 2.0.0
Feed Title: Segment7
Feed URL: http://blog.segment7.net/articles.rss
Feed Description: Posts about and around Ruby, MetaRuby, ruby2c, ZenTest and work at The Robot Co-op.
|
Latest Ruby Buzz Posts
Latest Ruby Buzz Posts by Eric Hodel
Latest Posts From Segment7
|
|
rdoc version 2.0.0 has been released!
http://rubyforge.org/projects/rdoc
http://rdoc.rubyforge.org/rdoc
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.
Changes:
- 3 Major Enhancements:
- Renamespaced everything RDoc under the RDoc module.
- New `ri` implementation.
- Reads from a cache in ~/.ri/ for enhanced speed.
- RubyGems aware, only searches latest gem versions.
- Now up to over 100 tests and 200 assertions.
- 4 Minor Enhancements:
- Switched to an ERb-based TemplatePage, see RDoc::TemplatePage.
- Class/module ri now displays attribute and constant comments.
- Cross-references can be disabled with a leading \.
- Relaxed parsing for some RDoc inline markup.
Bugs:
If you found a bug, please report it at the RDoc project's tracker on
RubyForge: http://rubyforge.org/tracker/?group_id=627
Synopsis:
gem 'rdoc'
require 'rdoc/rdoc'
# ... see RDoc
Read: RDoc 2.0.0