aboutsummaryrefslogtreecommitdiffstats
path: root/lib/rdoc/markup/formatter.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rdoc/markup/formatter.rb')
-rw-r--r--lib/rdoc/markup/formatter.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/rdoc/markup/formatter.rb b/lib/rdoc/markup/formatter.rb
index b6e12f82e7..bf904bba68 100644
--- a/lib/rdoc/markup/formatter.rb
+++ b/lib/rdoc/markup/formatter.rb
@@ -4,6 +4,10 @@ require 'rdoc/markup'
# Base class for RDoc markup formatters
#
# Formatters use a visitor pattern to convert content into output.
+#
+# 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.
class RDoc::Markup::Formatter