From: darren kirby <bulliver@...>
Date: 2006-09-19T04:11:50+09:00
Subject: Documenting attributes with Rdoc

Hello all,

I have written a Lib here that parses Flac files for information, and as 
the 'important' stuff is written to various attributes I want to document 
their data structure, as some of them are quite complex and require 
explanation.  I cannot figure out how to get Rdoc to work with them.

I have them all in an attr_reader, and Rdoc finds them and puts an [R] next to 
them which I presume indicates they are readonly.  That's all good but when I 
add some documentation above the attr_reader Rdoc adds the same text to all 8 
of my attributes.

I thought that I would trying creating the attributes the long way, ie:

def foo
  @foo
end

and document them that way, but when I do this Rdoc lumps them under instance 
methods, which is of course technically correct but I don't want that, I want 
them listed under attributes.

How can I do this? Should I just document them under the main package 
description?

thanks,
-d  
-- 
darren kirby :: Part of the problem since 1976 :: http://badcomputer.org
"...the number of UNIX installations has grown to 10, with more expected..."
- Dennis Ritchie and Ken Thompson, June 1972