From b5e63b0333bed1b14ab72d0adb025b45870cafe9 Mon Sep 17 00:00:00 2001 From: murphy Date: Sat, 29 Oct 2005 14:10:00 +0000 Subject: encoders/html.rb: Fixed documentation. (woah, RDoc!) --- lib/coderay/encoders/html.rb | 52 ++++++++++++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 16 deletions(-) (limited to 'lib/coderay/encoders') diff --git a/lib/coderay/encoders/html.rb b/lib/coderay/encoders/html.rb index 5da4e59..a722f18 100644 --- a/lib/coderay/encoders/html.rb +++ b/lib/coderay/encoders/html.rb @@ -22,22 +22,42 @@ module Encoders # # == Options # - # :tab_width:: Convert \t characters to +n+ spaces (a number.) - # Default: 8 - # :css:: How to include the styles; can be :class or :style. - # Default: :class - # :wrap:: Wrap in :page, :div, :span or nil. - # Default: :page - # You can also use Encoders::Div and Encoders::Span. - # :line_numbers:: Include line numbers in :table, :inline or nil (no line numbers) - # Default: nil - # :line_number_start: Where to start with line number counting. - # Default: 1 - # :bold_every:: Make every +n+-th number appear bold. - # Default: 10 - # :hint:: Include some information into the output using the title attribute. - # Can be :info (show token type on mouse-over) or :debug. - # Default: false + # === :tab_width + # Convert \t characters to +n+ spaces (a number.) + # Default: 8 + # + # === :css + # How to include the styles; can be :class or :style. + # + # Default: :class + # + # === :wrap + # Wrap in :page, :div, :span or nil. + # + # You can also use Encoders::Div and Encoders::Span. + # + # Default: :page + # + # === :line_numbers + # Include line numbers in :table, :inline or nil (no line numbers) + # + # Default: nil + # + # === :line_number_start + # Where to start with line number counting. + # + # Default: 1 + # + # === :bold_every + # Make every +n+-th number appear bold. + # + # Default: 10 + # + # === :hint + # Include some information into the output using the title attribute. + # Can be :info (show token type on mouse-over) or :debug. + # + # Default: false class HTML < Encoder include Streamable -- cgit v1.2.1