RDoc::Comment

Type:

Class

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.

tomdoc?() Instance Public methods Returns true if this comment is in TomDoc

text=(text) Instance Public methods Replaces this comment's text with text

force_encoding(encoding) Instance Public methods HACK dubious

remove_private() Instance Public methods Removes private sections from this

extract_call_seq(method) Instance Public methods Look for a 'call-seq' in the

empty?() Instance Public methods A comment is empty if its text String is empty

parse() Instance Public methods Parses the comment into an

new(text = nil, location = nil) Class Public methods Creates a new comment with

format=(format) Instance Public methods Sets the format of this comment and

normalize() Instance Public methods Normalizes the text. See