diff options
| author | murphy <murphy@rubychan.de> | 2005-10-29 14:10:00 +0000 |
|---|---|---|
| committer | murphy <murphy@rubychan.de> | 2005-10-29 14:10:00 +0000 |
| commit | b5e63b0333bed1b14ab72d0adb025b45870cafe9 (patch) | |
| tree | b0d63002444d2c03d0fb18130ff276b10d5b97b3 | |
| parent | 8d5663bcd25ca4ca0ed3fdb65f618060688dd2f0 (diff) | |
| download | coderay-b5e63b0333bed1b14ab72d0adb025b45870cafe9.tar.gz | |
encoders/html.rb: Fixed documentation. (woah, RDoc!)
| -rw-r--r-- | lib/coderay/encoders/html.rb | 52 |
1 files changed, 36 insertions, 16 deletions
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
|