RDoc

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).

For the medical framework, see Research Domain Criteria.
RDoc
Original author(s)Dave Thomas
Stable release
5.1.0 / February 24, 2017 (2017-02-24)
Repository
Written inRuby
Operating systemCross-platform
Typeembedded documentation generator
LicenseGPLv2
Websiteruby.github.io/rdoc/

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. In RDoc Markup, special directives are enclosed in a pair of colons. For example, to indicate that a method takes arguments called site and article, one can write :args: site, article.[1]

gollark: I can dredge up some usable alternatives, I suppose.
gollark: Why not?
gollark: Actually Additions, Applied Energistics 2, Ender IO, Thermal Expansion/Foundation/Innovation, Redstone Arsenal, CC: Tweaked, FoamFix (performance-improving mod), Compact Machines, Psi, Botania, Wireless Crafting Terminal, Tinkers' Construct, NuclearCraft, Plethora Peripherals, Quark, JEI (obviously), The One Probe (useful utility mod), Xaero's Minimap, Computronics, OpenComputers, Akashic Tome, Better Builders' Wands, ME Capability Adapter, RFTools.
gollark: I'm working on it.
gollark: Hold on while I dredge up my modlist.

See also

References
  1. "class RDoc::Markup". rdoc 6.0.4 Documentation.


This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.