abstract_parser.rb in marvin-0.8.2

- old
+ new

@@ -1,6 +1,7 @@
 module Marvin
+  # Abstract Class for implementing abstract parsers.
   class AbstractParser
     
     attr_accessor :line, :command, :event
     
     # Instantiates a parser instance, attempts to 
@@ -13,9 +14,11 @@
     
     def to_event
       @event
     end
     
+    # Parses a line and return the associated event.
+    # @return [Marvin::IRC:Event] the parsed event
     def self.parse(line)
       new(line.strip).to_event
     end
     
     protected
\ No newline at end of file