rdoc

rubyonrails-talk
1

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     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?

      Some of the questions may be blunders . But I am asking this since a beginner. Please guide me. Also please share any urls covering this

Thanks in advance Tom

2

Hi,

   1. How can I generate RDoc for my rails application        - if you want to generate rdoc for entire rails application than execute rake doc:app (it generate app HTML files).

   2. My application is only at a beginning stage . So should I create RDoc now it self?        - No. there is no need for that. after successful development you have to generate rdoc for application.

   4. Also when ever I create RDoc should I commit it to svn?        - Everytime creating rdoc & comment that. so at the end you have to create rdoc & commit.

3

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

Tom