View source for RDoc

{{for|the medical framework|Research Domain Criteria}}
{{more references|date=August 2018}}
{{Infobox Software
| name                   = RDoc
| screenshot             = 
| caption                = 
| author                 = [[Dave Thomas (programmer)|Dave Thomas]]
| developer              = 
| released               = 
| latest release version = 5.1.0
| latest release date    = {{Start date and age|2017|02|24}}
| latest preview version = 
| latest preview date    = 
| operating system       = [[Cross-platform]]
| platform               =
| programming language   = [[Ruby programming language|Ruby]]
| genre                  = [[Documentation generator|embedded documentation generator]]
| license                = [[GNU General Public License|GPLv2]]
| website                = {{URL|https://ruby.github.io/rdoc/}}
}}
'''RDoc''', designed by [[Dave Thomas (programmer)|Dave Thomas]], is an [[Documentation generator|embedded documentation generator]] for the [[Ruby programming language]].
It analyzes Ruby [[source code]], generating a structured collection of pages for Ruby [[Object (computer science)|objects]] and [[Method (computer programming)|methods]].
Code [[Comment (computer programming)|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 [[Parsing|parse]] the [[Class (computer programming)|classes]], [[Modular programming|modules]], and methods, and list them in the generated [[Application programming interface|API]] files. RDoc also provides the engine for creating Ruby ri data files, providing access to API information from the [[Command-line interface|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 {{code|site}} and {{code|article}}, one can write {{code|:args: site, article}}.<ref>{{cite web |title=class RDoc::Markup |url=https://ruby.github.io/rdoc/RDoc/Markup.html |website=rdoc 6.0.4 Documentation}}</ref>

== See also ==
{{Portal|Free and open-source software}}
* [[Comparison of documentation generators]]

==References==
{{Reflist}}

==External links==
* [[b:Ruby Programming/RubyDoc|Chapter on RubyDoc in the Ruby Wikibook]]

{{Ruby programming language}}

[[Category:Free documentation generators]]
[[Category:Free software programmed in Ruby]]
[[Category:Software using the GNU General Public License]]
[[Category:Cross-platform free software]]


{{Free-software-stub}}