File: comment.rb [rdoc-4.2.0 Documentation]

Last Modified
  2015-07-29 09:28:41 +0000
Requires

## Description

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 RDoc::Markup@Other+directives for instructions on adding an alternate format.