RDoc, designed by
Dave Thomas, is an
embedded documentation generator for the
Ruby programming language.
It analyzes Ruby
source code
In computing, source code, or simply code or source, is a plain text computer program written in a programming language. A programmer writes the human readable source code to control the behavior of a computer.
Since a computer, at base, only ...
, 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. The RDoc software and format are successors to the
Ruby Document format (with associated software RD).
RDoc can produce usable documentation even if the target source code does not contain explicit comments as it will still
parse the
classes,
modules, and methods, and list them in the generated
API
An application programming interface (API) is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build ...
files. RDoc also provides the engine for creating Ruby ri data files, providing access to API information from the
command line.
RDoc and ri are currently maintained by Eric Hodel and Ryan Davis.
Syntax
RDoc supports four markup languages, RDoc Markup,
Markdown, tomdoc, and rdtool. Its own RDoc Markup is used by default. In RDoc Markup, special directives are enclosed in a pair of colons. For example, to indicate that a method takes arguments called and , one can write .
See also
*
Comparison of documentation generators
References
External links
*
Chapter on RubyDoc in the Ruby Wikibook
Free documentation generators
Free software programmed in Ruby
Software using the GNU General Public License
Cross-platform free software
{{Free-software-stub