From: Roger Pack <rogerpack2005@...>
Date: 2009-11-06T00:40:05+09:00
Subject: Re: Rdoc with readable hashes

> I want to parse a ruby config of a window manager which utilizes hashes. 
> Is there a way to get a fancier ouput than this?
...
> OPTIONS = {
>   # Border size in pixel of the windows
>   :border  => 2,
> 
>   # Window move/resize steps in pixel per keypress
>   :step    => 5,

...

You could duplicate the descriptions in the RDOC comment, or you try and 
use an rdoc directive like :method:

http://rdoc.rubyforge.org/RDoc/Parser/Ruby.html

I think I've seen some docu that's like
#
#
# param:: describe something that could be in args
# param2:: again
def go args
end

but I'm not sure what that was for--yard?
-r
-- 
Posted via http://www.ruby-forum.com/.