Type:
Class
Constants:
InlineTag : Struct.new(:bit, :on, :off)

Tag for inline markup containing a bit for the bitmask and the on and off triggers.

Base class for RDoc markup formatters

Formatters are a visitor that converts an RDoc::Markup tree (from a comment) into some kind of output. RDoc ships with formatters for converting back to rdoc, ANSI text, HTML, a Table of Contents and other formats.

If you'd like to write your own Formatter use RDoc::Markup::FormatterTestCase. If you're writing a text-output formatter use RDoc::Markup::TextFormatterTestCase which provides extra test cases.

annotate

annotate(tag) Instance Public methods Allows tag to be decorated

2015-05-02 11:42:25
add_special_RDOCLINK

add_special_RDOCLINK() Instance Public methods Adds a special for links of the

2015-05-02 11:21:42
in_tt?

in_tt?() Instance Public methods Are we currently inside tt tags?

2015-05-02 12:08:20
convert_special

convert_special(special) Instance Public methods Converts added specials. See

2015-05-02 11:53:51
gen_relative_url

gen_relative_url(path, target) Class Public methods Converts a target url to

2015-05-02 11:13:06
new

new(options, markup = nil) Class Public methods Creates a new

2015-05-02 11:14:47
on_tags

on_tags(res, item) Instance Public methods Turns on tags for item

2015-05-02 12:14:32
add_special_TIDYLINK

add_special_TIDYLINK() Instance Public methods Adds a special for links of the

2015-05-02 11:28:35
ignore

ignore(*node) Instance Public methods Use ignore in your subclass to ignore

2015-05-02 12:03:20
convert_flow

convert_flow(flow) Instance Public methods Converts flow items flow

2015-05-02 11:51:33