From: Eric Hodel <drbrain@...7.net>
Date: 2010-04-03T05:40:49+09:00
Subject: Re: rdoc 2.5 Released

On Apr 2, 2010, at 02:19, Marvin Gülker wrote:

> Eric Hodel 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.

This is a bug.  Do you have a released gem I can look at to be sure I've fixed it?