Type:
Module
Constants:
MARKUP_FORMAT : { 'markdown' => RDoc::Markdown, 'rdoc' => RDoc::Markup, 'rd' => RDoc::RD, 'tomdoc' => RDoc::TomDoc, }

Maps markup formats to classes that can parse them. If the format is unknown, ârdocâ format is used.

TO_HTML_CHARACTERS : Hash.new do |h, encoding| h[encoding] = { :close_dquote => encode_fallback('â', encoding, '"'), :close_squote => encode_fallback('â', encoding, '\''), :copyright => encode_fallback('©', encoding, '(c)'), :ellipsis => encode_fallback('â¦', encoding, '...'), :em_dash => encode_fallback('â', encoding, '---'), :en_dash => encode_fallback('â', encoding, '--'), :open_dquote => encode_fallback('â', encoding, '"'), :open_squote => encode_fallback('â', encoding, '\''), :trademark => encode_fallback('®', encoding, '(r)'), } end if Object.const_defined? :Encoding

Maps an encoding to a Hash of characters properly transcoded for that encoding.

See also encode_fallback.

Methods for manipulating comment text

snippet

snippet(text, limit = 100) Instance Public methods The first limit

2015-05-04 20:20:13
parse

parse(text, format = 'rdoc') Instance Public methods Normalizes text

2015-05-04 20:13:33
encode_fallback

encode_fallback(character, encoding, fallback) Class Public methods Transcodes

2015-05-04 19:53:11
expand_tabs

expand_tabs(text) Instance Public methods Expands tab characters in text

2015-05-04 20:00:04
strip_newlines

strip_newlines(text) Instance Public methods Strips leading and trailing n characters

2015-05-04 20:28:48
flush_left

flush_left(text) Instance Public methods Flush text left based

2015-05-04 20:03:28
strip_hashes

strip_hashes(text) Instance Public methods Strips leading # characters from

2015-05-04 20:23:37
normalize_comment

normalize_comment(text) Instance Public methods Strips hashes, expands tabs

2015-05-04 20:12:47
markup

markup(text) Instance Public methods Convert a string in markup format into

2015-05-04 20:07:47
wrap

wrap(txt, line_len = 76) Instance Public methods Wraps txt to

2015-05-04 20:45:56