Documenting ruby doc

Rails
1

Hi,
I am looking for ways to document ruby classes, functions, etc.
All the references take me to RDOC but the project on source forge has
been marked inactive.
Does anybody know what to use, how to use or I just need to write
comments above class/function.

regards
abbasi

2

On Jun 1, 7:06pm, abbasi [email protected] wrote:

Hi,
I am looking for ways to document ruby classes, functions, etc.
All the references take me to RDOC but the project on source forge has
been marked inactive.
Does anybody know what to use, how to use or I just need to write
comments above class/function.

regards
abbasi

You use RDoc. It’s part of Ruby now. Issues are being tracked at Ruby
Forge not Source Forge anymore for RDoc.

http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse

It’s already stable and widely used enough that you can find
references anywhere on how to use it. Here’s a link from wikibooks to
help you get started.

http://en.wikibooks.org/wiki/Ruby_Programming/RubyDoc

B.