RDoc

RDoc

Original author(s)	Dave Thomas
Written in	Ruby
Operating system	Cross-platform
Type	embedded documentation generator
Website	RDoc documentation

RDoc, designed by Dave Thomas, is an embedded documentation generator for the Ruby programming language. It analyzes Ruby source code, generating a structured collection of pages for Ruby objects and methods. Code comments can be added in a natural style. RDoc is included as part of the Ruby core distribution.

RDoc produces usable documentation even if the target source code does not contain explicit comments. RDoc will still parse the classes, modules, and methods, and list them in the generated API files.

RDoc also provides the engine for creating Ruby ri data files. ri is (more or less) Ruby's version of man pages, providing access to API information from the command line.

RDoc and ri are currently maintained by Eric Hodel and Ryan Davis.

See also

• Comparison of documentation generators
• Ruby Document format

External links

• RDoc documentation (API)
• RDoc formatting - hard to find
• Bug reports and patches
• Chapter on RubyDoc in the Ruby Wikibook