A comment holds the text comment for a RDoc::CodeObject
and provides a unified way of cleaning it up and parsing it into an RDoc::Markup::Document
.
Each comment may have a different markup format set by format=. By default 'rdoc' is used. The :markup: directive tells RDoc
which format to use.
See Other directives at RDoc::Markup
for instructions on adding an alternate format.