Question

I am using Ruby on Rails 3.0.7 and I am writing some documentation for my application using RDoc. Since I have not found on the Web some good documentation with examples, what I would like to know is how to use the :include: directive at all.

Can you make me an example of using that in application files?

Answer 1

Here is the doc: http://rdoc.rubyforge.org/RDoc/Markup.html

And here is a very basic example:

First a ruby file, say /tests/my_func.rb

#:include: doc.txt 

def my_function
  puts "yo"
end 

Then a doc /tests/documentations/doc.txt

This describes the method very well

In command line (executed from /tests):

rdoc -i /Users/benjaminroth/Sites/Tests/rdoc/descriptions