[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

[ANN] rdoc 2.0.0 Released

Eric Hodel

4/11/2008 1:21:00 AM

rdoc version 2.0.0 has been released!

* <http://rubyforge.org/projects...
* <http://rdoc.rubyforge.org...

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...
* <http://rdoc.rubyforge.org...
10 Answers

Agile Laurel

4/11/2008 3:46:00 AM

0

Eric Hodel wrote:
> rdoc version 2.0.0 has been released!
>
> * <http://rubyforge.org/projects...
> * <http://rdoc.rubyforge.org...
>
> 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...
> * <http://rdoc.rubyforge.org...

up







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

--
Posted via http://www.ruby-....

James Tucker

4/11/2008 8:05:00 AM

0


On 11 Apr 2008, at 02:21, Eric Hodel wrote:
> rdoc version 2.0.0 has been released!
>
> * <http://rubyforge.org/projects...
> * <http://rdoc.rubyforge.org...
>
> 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...
> * <http://rdoc.rubyforge.org...
>

Yesssss...

Thank you so much! Bravo!

Rob Sanheim

4/11/2008 1:25:00 PM

0

awesome, thanks eric.

On Fri, Apr 11, 2008 at 4:05 AM, James Tucker <jftucker@gmail.com> wrote:
>
>
> On 11 Apr 2008, at 02:21, Eric Hodel wrote:
>
> > rdoc version 2.0.0 has been released!
> >
> > * <http://rubyforge.org/projects...
> > * <http://rdoc.rubyforge.org...
> >
> > 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...
> > * <http://rdoc.rubyforge.org...
> >
> >
>
> Yesssss...
>
> Thank you so much! Bravo!
>
>

Gordon Thiesfeld

4/11/2008 3:53:00 PM

0

On Thu, Apr 10, 2008 at 8:21 PM, Eric Hodel <drbrain@segment7.net> 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

Jeremy McAnally

4/11/2008 5:12:00 PM

0

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 Thiesfeld <gthiesfeld@gmail.com> wrote:
> On Thu, Apr 10, 2008 at 8:21 PM, Eric Hodel <drbrain@segment7.net> 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
>
>



--
http://jeremymca...
http:...

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

Or, my blogs:
http://mrneig...
http://rubyinpr...

Gordon Thiesfeld

4/11/2008 6:08:00 PM

0

On Fri, Apr 11, 2008 at 12:12 PM, Jeremy McAnally
<jeremymcanally@gmail.com> 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!

Lars Christensen

4/16/2008 1:56:00 PM

0

On Apr 11, 3:21 am, Eric Hodel <drbr...@segment7.net> 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

matt

4/16/2008 4:01:00 PM

0

Lars <larsch@belunktum.dk> wrote:

> On Apr 11, 3:21 am, Eric Hodel <drbr...@segment7.net> 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... :) m.


--
matt neuburg, phd = matt@tidbits.com, http://www.tidbits...
Leopard - http://www.takecontrolbooks.com/leopard-custom...
AppleScript - http://www.amazon.com/gp/product/...
Read TidBITS! It's free and smart. http://www.t...

Eric Hodel

4/16/2008 9:01:00 PM

0

On Apr 16, 2008, at 09:05 AM, matt neuburg wrote:
> Lars <larsch@belunktum.dk> wrote:
>
>> On Apr 11, 3:21 am, Eric Hodel <drbr...@segment7.net> 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... :) m.

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

Lars Christensen

5/8/2008 10:18:00 AM

0

On Apr 16, 11:01 pm, Eric Hodel <drbr...@segment7.net> 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