This article needs additional citations for verification. (August 2018) (Learn how and when to remove this template message)
|Original author(s)||Dave Thomas|
5.1.0 / February 24, 2017
|Type||embedded documentation generator|
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. 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 files. RDoc also provides the engine for creating Ruby ri data files, providing access to API information from the command line.
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
article, one can write
:args: site, article.
- "class RDoc::Markup". rdoc 6.0.4 Documentation.
|This software article is a stub. You can help Wikipedia by expanding it.|