Forum: Ruby RDoc and multiple attr_accessor's

Posted by Lee Jackson (mrbandersnatch)
on 2013-01-16 12:18
Sorry, I have searched, and its a trivial question which I just can't
work out how to markup.

If I have an attr_accessor with multiple symbols e.g.

attr_accessor :name, :id, :price, :img

how do I use RDoc correctly to document them? The documentation output
repeats any comments preceding the attr_accessor...

TIA

Lee
Posted by Lee Jackson (mrbandersnatch)
on 2013-01-17 21:25
So I've had a browse over source code on google and can't find an 
example of what I was trying to do. Just in case there's no response 
since my question wasn't clear I want to use rdoc and document my 
attr_accessors similar too :

# id:: an identifier
# price:: total cost
attr_accessor :id, :price

I'd assumed rdoc would handle this similarly to documenting a methods 
parameters, but instead the documentation comments are repeated for each 
symbol.

While I can, of course, use 1 line per symbol I find it hard to believe 
that rdoc would force such a style....
Please log in before posting. Registration is free and takes only a minute.
Existing account (Switch to SSL-encrypted connection)
NEW: Do you have a Google/GoogleMail or Yahoo account? No registration required!
Log in with Google account | Log in with Yahoo account
No account? Register here.