CODEWITHSUNDEEP
ruby-on-railsruby-on-rails-3documentation
Mohit Jain
Mohit Jain

Reputation: 43949

How to generate docs for my models and controller in rails

I want to create docs for the models and controller of my application. Even for rake task, any background job. As I have thousands of lines of comments inline between the code, explanation of the all the functions actions..

I don't want docs for rails so 

  rake doc:rails

is useless for me.

Usecase is internal detailed developer notes.

Upvotes: 6

Views: 6982

Answers (1)

Devin M
Devin M

Reputation: 9752

Try using this rake task:

rake doc:app

This task is provided by Rdoc. It also supports some markup that you can use to make things look better when formatted. You can see examples in the documentation.

Upvotes: 12

Related Questions