How to RDOC

[ReggieB]

I should have been using RDOC earlier, but I guess better late than never.

It seems fairly simple to generate RDOC documentation in a Rails application:

rake appdoc

However, I understand that RDOC has the facility to detect comments in the code and add them to the documentation pages. However, I can't see how to either tell RDOC to include my comments, or flag the comments so that RDOC will use them. How do I get RDOC to identify and post my comments into the documentation?

Finding a solution isn't helped by the fact that seaching for help on RDOC documentation leads to lots of links to documentation created with RDOC.

[philm]

Type "rdoc —help" for an up-to-date option summary.

http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/

All I could find for you...

[ReggieB]

I think I've cracked it. I had a look at rdoc.rb and the way that was set up and I've worked out what I was doing wrong. I was writing my code like this:

def a_method
  #Comment describing the method
  .... bit of code ....
end

For RDoc to detect the comment it needs to be outside of and before the method statement. For example:

#Comment describing the method
def a_method
  .... bit of code ....
end

Perhaps I should have known that, but I could not find documentation stating that was where the method comments should go, but now I know.

[philm]

Ahh nice, one!

I love it when a plan comes together

[ReggieB]

Thanks for your help.