From: "Marvin Gülker" <sutniuq@...>
Date: 2010-04-02T18:19:36+09:00
Subject: Re: rdoc 2.5 Released

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.

Marvin
-- 
Posted via http://www.ruby-forum.com/.