RDoc

E695748

RDoc is a Ruby documentation generation tool that produces formatted API and project documentation from specially structured comments in source code.

All labels observed (1)

Label Occurrences
RDoc canonical 1

How this entity was disambiguated

Statements (48)

Predicate Object
instanceOf Ruby tool
software documentation generator
category developer tool
software documentation
developer Ruby community
hasFeature command-line interface
generation of ri data files
integration with RubyGems
linking to classes and methods in text
markup language for comments
parsing of Ruby syntax
section and heading markup in comments
support for custom generators
support for documenting private and public APIs
template-based output
homepage https://ruby.github.io/rdoc/
includedSinceVersion Ruby 1.4.4
inputType Ruby source code files
specially structured comments in source code
license BSD-2-Clause
Ruby License NERFINISHED
maintainer Ruby core team NERFINISHED
outputType HTML documentation
Markdown (via plugins or extensions)
RI documentation
partOf Ruby standard library
platform cross-platform
primaryFunction generate documentation from source code comments
produce API documentation
produce project documentation
programmingLanguage Ruby NERFINISHED
relatedTo RubyGems NERFINISHED
YARD NERFINISHED
repository https://github.com/ruby/rdoc
runsOn Ruby interpreter
supports class documentation
constant documentation
cross-references between documented items
documentation for Ruby gems
file-level documentation
inline code examples
method documentation
module documentation
supportsLanguage Ruby NERFINISHED
usedBy Ruby developers
usedFor generating API docs for Ruby libraries
generating documentation for Ruby on Rails projects
writtenIn Ruby NERFINISHED

How these facts were elicited

Referenced by (1)

Full triples — surface form annotated when it differs from this entity's canonical label.

Markdown influenced RDoc