summaryrefslogtreecommitdiff
path: root/lib/coderay/encoders/text.rb
diff options
context:
space:
mode:
authormurphy <murphy@rubychan.de>2010-03-30 01:13:11 +0000
committermurphy <murphy@rubychan.de>2010-03-30 01:13:11 +0000
commit8f8d029f1e9ba286e43cedc274a89bae3fb318b4 (patch)
tree56e32bd33788c37f20a4d2f3bd51e58ad4c45022 /lib/coderay/encoders/text.rb
parent476bc1bfe2f2000acc665f034e7da19bd3f0cc6b (diff)
downloadcoderay-8f8d029f1e9ba286e43cedc274a89bae3fb318b4.tar.gz
Added documentation to encoders; more code cleanups.
Diffstat (limited to 'lib/coderay/encoders/text.rb')
-rw-r--r--lib/coderay/encoders/text.rb13
1 files changed, 12 insertions, 1 deletions
diff --git a/lib/coderay/encoders/text.rb b/lib/coderay/encoders/text.rb
index 161ee67..26fef84 100644
--- a/lib/coderay/encoders/text.rb
+++ b/lib/coderay/encoders/text.rb
@@ -1,6 +1,17 @@
module CodeRay
module Encoders
-
+
+ # Concats the tokens into a single string, resulting in the original
+ # code string if no tokens were removed.
+ #
+ # Alias: +plain+
+ #
+ # == Options
+ #
+ # === :separator
+ # A separator string to join the tokens.
+ #
+ # Default: empty String
class Text < Encoder
include Streamable