A simple tool for Ruby developers to help them automatically generate documentation sites out of their project's source code comments
One is rdoc, an utility for generating HTML documentation. The second is ri, a tool for creating documentation for the Ruby command-line interface.
To be able to properly use RDoc, the developer must change the way he adds comments to his source code.
RDoc uses a specific source code comments structure, so they can easily be extracted and help populate the documentation site.
RDoc's comment structure is extremely successful, being used by many similar documentation generators created for other programming languages.
In a hurry? Add it to your Download Basket!
What's New in This Release:
- RDoc can now produce translation files for use with gettext.