1 files changed, 38 insertions, 30 deletions
diff --git a/lib/coderay/encoders/debug.rb b/lib/coderay/encoders/debug.rb
index 7358e8b..d6aac8b 100644
--- a/lib/coderay/encoders/debug.rb
+++ b/lib/coderay/encoders/debug.rb
@@ -1,38 +1,46 @@
 module CodeRay
-	module Encoders
-
-		# = Debug Encoder
-		class Debug < Encoder
-
-			include Streamable
-			register_for :debug
-
-			FILE_EXTENSION = 'raydebug'
-
-		protected
-			def text_token text, kind
-				@out <<
-					if kind == :space
-						text
-					else
-						text = text.gsub(/[)\\]/, '\\\\\0')
-						"#{kind}(#{text})"
-					end					
-			end
-
-			def block_token action, kind
-				@out << super
-			end
+module Encoders
+
+	# = Debug Encoder
+	#
+	# Fast encoder producing simple debug output.
+	#
+	# It is readable and diff-able and is used for testing.
+	#
+	# You cannot fully restore the tokens information from the
+	# output, because consecutive :space tokens are merged.
+	# Use Tokens#dump for caching purposes.
+	class Debug < Encoder
+
+		include Streamable
+		register_for :debug
+
+		FILE_EXTENSION = 'raydebug'
+
+	protected
+		def text_token text, kind
+			@out <<
+				if kind == :space
+					text
+				else
+					text = text.gsub(/[)\\]/, '\\\\\0')
+					"#{kind}(#{text})"
+				end					
+		end
 
-			def open_token kind
-				"#{kind}<"
-			end
+		def block_token action, kind
+			@out << super
+		end
 
-			def close_token kind
-				">"
-			end
+		def open_token kind
+			"#{kind}<"
+		end
 
+		def close_token kind
+			">"
 		end
 
 	end
+
+end
 end