Class: RDoc::Comment
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Text
|
|
Inherits: | Object |
Defined in: | lib/rdoc/comment.rb |
Overview
A comment holds the text comment for a CodeObject and provides a unified way of cleaning it up and parsing it into an 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.
Constant Summary
Text - Included
Class Method Summary
- .new(text = nil, location = nil) ⇒ Comment constructor
Instance Attribute Summary
-
#format
rw
The format of this comment.
-
#format=(format)
rw
Sets the format of this comment and resets any parsed document.
-
#location
(also: #file)
rw
The TopLevel this comment was found in.
-
#text
rw
The text for this comment.
-
#text=(text)
rw
Replaces this comment's text with #text and resets the parsed document.
-
#empty? ⇒ Boolean
readonly
A comment is empty if its text String is empty.
-
#tomdoc? ⇒ Boolean
readonly
Returns true if this comment is in TomDoc format.
-
#document=(value)
writeonly
Overrides the content returned by #parse.
Instance Method Summary
-
#extract_call_seq(method)
Look for a 'call-seq' in the comment to override the normal parameter handling.
-
#force_encoding(encoding)
HACK dubious.
-
#normalize
Normalizes the text.
-
#parse
Parses the comment into an Markup::Document.
-
#remove_private
Removes private sections from this comment.
Text - Included
#expand_tabs | Expands tab characters in #text to eight spaces. |
#flush_left | Flush #text left based on the shortest line. |
#markup | Convert a string in markup format into HTML. |
#normalize_comment | Strips hashes, expands tabs then flushes #text to the left. |
#parse | Normalizes #text then builds a Markup::Document from it. |
#snippet | The first |
#strip_hashes | Strips leading # characters from #text |
#strip_newlines | Strips leading and trailing n characters from #text |
#strip_stars | Strips /* */ style comments. |
#to_html | Converts ampersand, dashes, ellipsis, quotes, copyright and registered trademark symbols in #text to properly encoded characters. |
#wrap | Wraps |
Constructor Details
.new(text = nil, location = nil) ⇒ Comment
[ GitHub ]
Instance Attribute Details
#document=(value) (writeonly)
[ GitHub ]# File 'lib/rdoc/comment.rb', line 40
attr_writer :document
#empty? ⇒ Boolean
(readonly)
A comment is empty if its text String is empty.
# File 'lib/rdoc/comment.rb', line 129
def empty? @text.empty? end
#format (rw)
The format of this comment. Defaults to Markup
# File 'lib/rdoc/comment.rb', line 19
attr_reader :format
#format=(format) (rw)
Sets the format of this comment and resets any parsed document
#location (rw) Also known as: #file
The TopLevel this comment was found in
# File 'lib/rdoc/comment.rb', line 24
attr_accessor :location
#text (rw)
The text for this comment
# File 'lib/rdoc/comment.rb', line 34
attr_reader :text
#text=(text) (rw)
Replaces this comment's text with #text and resets the parsed document.
An error is raised if the comment contains a document but no text.
#tomdoc? ⇒ Boolean
(readonly)
Returns true if this comment is in TomDoc format.
# File 'lib/rdoc/comment.rb', line 225
def tomdoc? @format == 'tomdoc' end
Instance Method Details
#extract_call_seq(method)
Look for a 'call-seq' in the comment to override the normal parameter handling. The :call-seq: is indented from the baseline. All lines of the same indentation level and prefix are consumed.
For example, all of the following will be used as the :call-seq:
# :call-seq:
# ARGF.readlines(sep=$/) -> array
# ARGF.readlines(limit) -> array
# ARGF.readlines(sep, limit) -> array
#
# ARGF.to_a(sep=$/) -> array
# ARGF.to_a(limit) -> array
# ARGF.to_a(sep, limit) -> array
# File 'lib/rdoc/comment.rb', line 84
def extract_call_seq method # we must handle situations like the above followed by an unindented first # comment. The difficulty is to make sure not to match lines starting # with ARGF at the same indent, but that are after the first description # paragraph. if @text =~ /^\s*:?call-seq:(.*?(?:\S).*?)^\s*$/m then all_start, all_stop = $~.offset(0) seq_start, seq_stop = $~.offset(1) # we get the following lines that start with the leading word at the # same indent, even if they have blank lines before if $1 =~ /(^\s*\n)^(\s*\w)/m then leading = $2 # ' * ARGF' in the example above re = %r% \A( (^\s*\n)+ (^#{Regexp.escape leading}.*?\n)+ )+ ^\s*$ %xm if @text[seq_stop..-1] =~ re then all_stop = seq_stop + $~.offset(0).last seq_stop = seq_stop + $~.offset(1).last end end seq = @text[seq_start..seq_stop] seq.gsub!(/^\s*(\S|\n)/m, '\1') @text.slice! all_start...all_stop method.call_seq = seq.chomp elsif @text.sub!(/^\s*:?call-seq:(.*?)(^\s*$|\z)/m, '') then seq = $1 seq.gsub!(/^\s*/, '') method.call_seq = seq end method end
#force_encoding(encoding)
HACK dubious
# File 'lib/rdoc/comment.rb', line 136
def force_encoding encoding @text.force_encoding encoding end
#normalize
Normalizes the text. See Text#normalize_comment for details
# File 'lib/rdoc/comment.rb', line 157
def normalize return self unless @text return self if @normalized # TODO eliminate duplicate normalization @text = normalize_comment @text @normalized = true self end
#parse
Parses the comment into an Markup::Document. The parsed document is cached until the text is changed.
# File 'lib/rdoc/comment.rb', line 179
def parse return @document if @document @document = super @text, @format @document.file = @location @document end
#remove_private
Removes private sections from this comment. Private sections are flush to the comment marker and start with --
and end with +
</tt>. For C-style comments, a private marker may not start at the opening of the comment.
/*
*--
* private
*++
* public
*/
# File 'lib/rdoc/comment.rb', line 200
def remove_private # Workaround for gsub encoding for Ruby 1.9.2 and earlier empty = '' empty.force_encoding @text.encoding if Object.const_defined? :Encoding @text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\\\n?%m, empty) @text = @text.sub(%r%^\s*[#*]?--.*%m, '') end