# Rdoc 2.5 Released **URL:** \ **Category:** Ruby\ **Created:** [April 1, 2010, 10:22am UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160 "2010-04-01T10:22:43Z")\ **Posts on this page:** 8\ **Page:** 1
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 1, 2010, 10:22am UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/1 "2010-04-01T10:22:43Z")
rdoc version 2.5 has been released! - RDoc Project Page [http://rubyforge.org/projects/rdoc/](http://rubyforge.org/projects/rdoc/) - RDoc Documentation [http://rdoc.rubyforge.org/](http://rdoc.rubyforge.org/) - RDoc Bug Tracker [http://rubyforge.org/tracker/?atid=2472&group\_id=627&func=browse](http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse) 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 RDoc 1.0.1. Command-line tools are largely unaffected, but internal APIs may shift rapidly. See RDoc for a description of RDoc’s markup and basic use. Changes: ### 2.5 / 2010-03-31 _NOTE_: You’ll need to: gem install rdoc-data then run: rdoc-data to have ri data for core and stdlib like Array or Kernel or Date. - 9 Major Enhancements - 17 Minor Enhancements - 12 Bug Fixes ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 1, 2010, 7:25pm UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/2 "2010-04-01T19:25:52Z")
On Apr 1, 2010, at 1:16, Eric H. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote: > rdoc-data > > to have ri data for core and stdlib like Array or Kernel or Date. One more thing, you’ll need to rebuild ri data for gems too: gem rdoc --all --overwrite --no-rdoc If you want that glorious Home link in your ‘gem server’ output remove –no-rdoc. ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 1, 2010, 9:08pm UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/3 "2010-04-01T21:08:00Z")
> You’ll need to: > > gem install rdoc-data > > then run: > > rdoc-data Thanks for the update. Appears to parse the core stuffs well now. -rp ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 2, 2010, 1:50am UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/4 "2010-04-02T01:50:28Z")
On Apr 1, 2010, at 12:08, Roger P. wrote: > > You’ll need to: > > > > gem install rdoc-data > > > > then run: > > > > rdoc-data > > Thanks for the update. Appears to parse the core stuffs well now. I made sure to make rdoc parsing be warning-free for ruby (and most other gems). I ran rdoc 2.5 against all the released gems using gauntlet and found under five that RDoc couldn’t handle. I think one had .rb files that didn’t contain ruby and another two had hundred-thousand-character long line that was a single constant. I think rdoc would succeed on those really-really-really-long-constants when I didn’t get impatient. ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 2, 2010, 11:19am UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/5 "2010-04-02T11:19:34Z")
Eric H. wrote: > rdoc version 2.5 has been released! Why don’t you allow headings in method documentations any more? I’ve become used to document my methods like this: * * * #Method description #===Parameters #[par1] This and that… #[par2] foo bar #===Return value #This will be returned… #===Example # #Some example code ## #===Remarks #This has to be mentioned, too. def my\_awesome\_method(par1, par2) #Code… end When I try to document this, all the equal signs show up in the output. Btw. this is the same for the C parser. Marvin ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 2, 2010, 10:41pm UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/6 "2010-04-02T22:41:14Z")
On Apr 2, 2010, at 02:19, Marvin Gülker wrote: > #[par2] foo bar > > When I try to document this, all the equal signs show up in the output. > Btw. this is the same for the C parser. This is a bug. Do you have a released gem I can look at to be sure I’ve fixed it? ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 2, 2010, 11:38pm UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/7 "2010-04-02T23:38:01Z")
On Apr 2, 2010, at 14:24, Marvin Gülker wrote: > I’ve attached my work. > I’ve confirmed this is fixed this in trunk. I have one other bug report > from ruby core to fix then I should be able to release. ---
**Author:** ![miracleofmagick](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/71c47a/32.png) [@miracleofmagick](https://www.ruby-forum.com/u/miracleofmagick)\ **Post date:** [April 2, 2010, 11:24pm UTC](https://www.ruby-forum.com/t/rdoc-2-5-released/186160/8 "2010-04-02T23:24:10Z")
Eric H. wrote: > On Apr 2, 2010, at 02:19, Marvin G�lker wrote: > > > #[par2] foo bar > > > > When I try to document this, all the equal signs show up in the output. > > Btw. this is the same for the C parser. > > This is a bug. Do you have a released gem I can look at to be sure I’ve > fixed it? I’m the maintainer of the gems au3 and xdo, but when I released them I wasn’t as detailed as I am now. 😉 However, I’m working on a third gem, don’t assume this works, but the documentation is already there (with details!). Just look at the Imitator:❌:XWindow class (btw. the XWindow.search class method also illustrates the multiline :call-seq: issue). Just run “rake rdoc”. I’ve attached my work. Marvin