MENU
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.

in_tt?
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
convert_special
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
annotate
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
add_special_RDOCLINK
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
add_special_TIDYLINK
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
gen_relative_url
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
on_tags
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
ignore
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

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

2025-01-10 15:47:30
off_tags
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::Markup/RDoc::Markup::Formatter

off_tags(res, item) Instance Public methods Turns off tags for item

2025-01-10 15:47:30