Rdoc 2.0.0 Released

Ruby
1

rdoc version 2.0.0 has been released!

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:

2.0.0 / 2008-04-10

  • 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.

  • http://rubyforge.org/projects/rdoc/

  • http://rdoc.rubyforge.org/rdoc/

2

Eric H. wrote:

rdoc version 2.0.0 has been released!

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:

2.0.0 / 2008-04-10

  • 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.

  • http://rubyforge.org/projects/rdoc/

  • http://rdoc.rubyforge.org/rdoc/

up

visit a rubyonrails website :http://www.rorchina.net
wolf union program club :http://wolf.rorchina.net
China Rubyonrails club: http://bbs.rorchina.net

3

awesome, thanks eric.

4

On 11 Apr 2008, at 02:21, Eric H. wrote:

Yesssss…

Thank you so much! Bravo!

5

To other classes, files, methods, etc. For example, if you use the
word “find” in AR::Base’s docs, it will link to the docs for the
AR::Base.find method.

–Jeremy

On Fri, Apr 11, 2008 at 11:53 AM, Gordon T.
[email protected] wrote:

you elaborate?

Anyway, thanks. This is great.

Gordon

–
http://jeremymcanally.com/
http://entp.com

Read my books:
Ruby in Practice (Ruby in Practice)
My free Ruby e-book (http://humblelittlerubybook.com/)

Or, my blogs:

http://rubyinpractice.com

6

On Fri, Apr 11, 2008 at 12:12 PM, Jeremy McAnally
[email protected] wrote:

To other classes, files, methods, etc. For example, if you use the
word “find” in AR::Base’s docs, it will link to the docs for the
AR::Base.find method.

–Jeremy

Got it. Thanks!

7

On Apr 11, 3:21 am, Eric H. [email protected] wrote:

rdocversion 2.0.0 has been released!

Maybe I am overlooking something, but shouldn’t this work?:

C:>ri File.new
Updating class cache with 744 classes…
Nothing known about File.new

It worked before installing rdoc 2.0.0 (using gems, with otherwise
clean Windows One-Click installer (1.8.6-26))

Lars

8

On Thu, Apr 10, 2008 at 8:21 PM, Eric H. [email protected]
wrote:

rdoc version 2.0.0 has been released!

  • Cross-references can be disabled with a leading .

Eric,

Sorry if this is a dumb question but cross-references to what? Could
you elaborate?

Anyway, thanks. This is great.

Gordon

9

Lars [email protected] wrote:

On Apr 11, 3:21 am, Eric H. [email protected] wrote:

rdocversion 2.0.0 has been released!

Maybe I am overlooking something, but shouldn’t this work?:

C:>ri File.new
Updating class cache with 744 classes…
Nothing known about File.new

Try

ri File::new

I’m not a big fan of lazy dot-notation in any case… :slight_smile: m.

10

On Apr 16, 11:01 pm, Eric H. [email protected] wrote:

C:>ri File.new
Nothing known about File.new

Hrm, it is a bug, can one of you file it for me so I don’t forget?
Thanks.

I filed it at RubyForge, including another regarding links in the
generated HTML. Many bugs there are very old; are anyone looking at
them?

Lars

11

On Apr 16, 2008, at 09:05 AM, matt neuburg wrote:

Try

ri File::new

I’m not a big fan of lazy dot-notation in any case… :slight_smile: m.

Hrm, it is a bug, can one of you file it for me so I don’t forget?
Thanks.