# Rdoc

**URL:** <https://www.ruby-forum.com/t/rdoc/184044>\
**Category:** Rails\
**Created:** [February 24, 2010, 7:14am UTC](https://www.ruby-forum.com/t/rdoc/184044 "2010-02-24T07:14:15Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [February 24, 2010, 7:14am UTC](https://www.ruby-forum.com/t/rdoc/184044/1 "2010-02-24T07:14:15Z")

</div>

Hi  
I am asked to prepare RDoc for my rails application. I have a number of  
questions relating to this? I have only a basic idea of generating RDoc  
which I got from  
[Ruby Programming/RubyDoc - Wikibooks, open books for an open world](http://en.wikibooks.org/wiki/Ruby_Programming/RubyDoc)  
My questions

1. How can I generate RDoc for my rails application

2. My application is only at a beginning stage . So should I create  
RDoc now it self?

3. Any special pattern I should follow in my code for generating RDoc?

4. Also when ever I create RDoc should I commit it to svn?

Thanks in advance  
Tom

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [February 24, 2010, 8:58am UTC](https://www.ruby-forum.com/t/rdoc/184044/2 "2010-02-24T08:58:52Z")

</div>

Hi,

1. How can I generate RDoc for my rails application

2. My application is only at a beginning stage . So should I create  
RDoc now it self?

3. Also when ever I create RDoc should I commit it to svn?

---

<div class="post-metadata">

**Author:** ![tom-mac](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/bc8723/32.png) [@tom-mac](https://www.ruby-forum.com/u/tom-mac)\
**Post date:** [February 24, 2010, 9:54am UTC](https://www.ruby-forum.com/t/rdoc/184044/3 "2010-02-24T09:54:43Z")

</div>

hi  
Thanks. I dinot understand answer to 4 th question. Also what about  
question 3.  
Thanks again

Tom
