RDoc
From Wikipedia, the free encyclopedia
| RDoc | |
|---|---|
| Design by | Dave Thomas |
| Written in | Ruby |
| OS | Cross-platform |
| Genre | embedded documentation generator |
| Website | RDoc documentation |
RDoc, designed by Dave Thomas, is the embedded documentation generator for the Ruby programming language. It analyzes the 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 is useful 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, serving up API information from the command line.
RDoc and ri are currently maintained by Eric Hodel and Ryan Davis. Bug reports and patches may be submitted via RubyForge.org
[edit] External links
|
||||||||||||||
 |
This software-related article is a stub. You can help Wikipedia by expanding it. |
