lib/rouge/formatter.rb in rouge-0.2.0 vs lib/rouge/formatter.rb in rouge-0.2.1

@@ -1,23 +1,30 @@
 module Rouge
+  # A Formatter takes a token stream and formats it for human viewing.
   class Formatter
     REGISTRY = {}
 
+    # Specify or get the unique tag for this formatter.  This is used
+    # for specifying a formatter in `rougify`.
     def self.tag(tag=nil)
       return @tag unless tag
       REGISTRY[tag] = self
 
       @tag = tag
     end
 
+    # Find a formatter class given a unique tag.
     def self.find(tag)
       REGISTRY[tag]
     end
 
+    # Format a token stream.
     def render(tokens)
       enum_for(:stream, tokens).to_a.join
     end
 
+    # @abstract
+    # yield strings that, when concatenated, form the formatted output
     def stream(tokens, &b)
       raise 'abstract'
     end
   end
 end