class
RDoc::Comment
ruby latest stable
- Superclass: Object
frozen_string_literal: true
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.
Included modules
- RDoc::Text
Attributes
| [W] | document |
| [RW] | file |
| [R] | format |
| [RW] | location |
| [R] | text |
Files
- lib/rdoc/comment.rb