File: formatter.rb [rdoc: Ruby Standard Library Documentation]

Last Modified
  2020-10-01 07:15:38 -0500
Requires

## Description

frozen_string_literal: true

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.