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.
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.
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.
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/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:
>
> ### 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/>
>
>
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?
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.
m.