RI and RDoc
Rdoc is a nifty documentation harvesting tool created by Dave Thomas. Even with no programmer written documentation, rdoc can walk through a project and extract useful information from your code. If you put in a minimum of comments in your code, they are pulled out and associated with the correct feature of your code. RI is a command-line documentation viewing utility that presents information assembled by RDoc, although the HTML view is often more useful.
New Articles
from around the Web
-
On Ruby: RDoc (from the Archive)
Nice write-up on using rdoc and how its mark-up works.
Sorry, no books yet
for this category
Have one to suggest? Enter in the form on the right.
Links by Type
Documentation (1)
- rdoc: Ruby Standard Library Documentation
Official read-me for Rdoc.
Software (1)
- eigenclass - FastRI: faster, smarter RI docs for Ruby, DRb-enabled
FastRI is an alternative to the “ri” documentation browser for Ruby, is faster, has better indexing, and uses different searching algorithms for extracting information from a documentation collection.
Top Blogs
Sorry, no relevant blogs yet.
Have one to suggest? Enter in the form on the right.
