Ruby on Rails

RDoc[1] is a documentation generator, it's both a markup[2] and a
parser. All you need to get started is the rdoc gem:

gem install rdoc

Then all you need to do is add some rdoc flavored comments to your
source code, and the 'rdoc' command from your source tree will
generate html pages for all your code.

There are plenty of other documentation generators for Ruby[3], find
one that works for you; I personally prefer rdoc and rocco, but you've
got lots of options.

1: http://rdoc.rubyforge.org/
2: http://rdoc.rubyforge.org/RDoc/Markup.html
3: https://www.ruby-toolbox.com/categories/documentation_tools

On Thu, Feb 2, 2012 at 7:26 AM, honey ruby <emailtohoneyruby@gmail.com> wrote:
> hey everyone i was looking for a documentation for my project when i
> google it i found Rdoc but can not understand what exactly this Rdoc
> does. can any one help me to know about Rdoc.
>
> thanks in advance
>
> --
> You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group.
> To post to this group, send email to rubyonrails-talk@googlegroups.com.
> To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en.
>

--
You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group.
To post to this group, send email to rubyonrails-talk@googlegroups.com.
To unsubscribe from this group, send email to rubyonrails-talk+unsubscribe@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/rubyonrails-talk?hl=en.