RDoc
embedded documentation generator for the Ruby programming language
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 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.
The public source identifies “RDoc” as embedded documentation generator for the Ruby programming language. This brief keeps that definition visible, then builds a research path around RDoc, embedded and documentation.
Why this record matters
A short description can identify a subject without explaining its stakes. For “RDoc”, the useful work is to connect “embedded documentation generator for the Ruby programming language” to the records capable of establishing context and consequence.
The citation trail is more important than the brevity of the summary: it shows where individual claims can be examined in context. The source revision retrieved here is dated Oct 20, 2025. The linked authority identifier is Q3415130. 1 of 1 selected statements include explicit references; 0 carry qualifiers and 0 use preferred rank.
A concise general-reference account can conceal disagreements about scope, terminology or the weight assigned to individual sources. The lead is largely declarative, so disagreement and counter-evidence require a deliberate search beyond the opening account. Authority statements aid reconciliation but still require their own references, qualifiers and ranks to be checked.
How to read it
Use the entry as an orientation point, then follow its citations and revision history. Names, dates and institutional relationships should be checked against the original record.
- Subject orientation
- Search vocabulary
- Locating named sources
The closest primary source, responsible institution and strongest cited specialist reference.
Three-step research path
- Establish the record: confirm the title “RDoc”, its source revision and the description used here.
- Expand the search: follow RDoc primary sources, RDoc archive and RDoc research across catalogues and specialist indexes.
- Test the account: compare the strongest cited source with the responsible institution’s current record and note any disagreement.
Questions for further research
- Which source most directly establishes the central claim about “RDoc”?
- Which institution is responsible for the underlying evidence?
- What terminology or title could unlock a more precise catalogue search?
Search terms from this dossier
This entry incorporates text from “RDoc” on English Wikipedia. Contributors are listed in the page history. Text is available under the Creative Commons Attribution-ShareAlike 4.0 License. Selected authority identifiers and statements are retrieved from Wikidata under CC0; their references and qualifiers remain part of the verification path.