Here is an exemple of HTML generated documention with RDoc.

I tried to describe the most basic things to learn in order to produce clean and functional documentation. It‘s very easy to get start. Go on and start writing RDoc friendly comments!

To see the demo, just visit PostsController (That‘s where all the action is…)

You can also have a look at the source code of PostsController to realize how the RDoc-friendly comments look like your usual ruby comments.