some better tomdoc

Author: technoweenie

lib/email_reply_parser.rb

@@ -32,7 +32,7 @@
 class EmailReplyParser
   VERSION = "0.4.0"
 
-  # Splits an email body into a list of Fragments.
+  # Public: Splits an email body into a list of Fragments.
   #
   # text - A String email body.
   #
@@ -41,6 +41,11 @@ def self.read(text)
     Email.new.read(text)
   end
 
+  # Public: Get the text of the visible portions of the given email body.
+  #
+  # text - A String email body.
+  #
+  # Returns a String.
   def self.parse_reply(text)
     self.read(text).visible_text
   end
@@ -56,7 +61,9 @@ def initialize
       @fragments = []
     end
 
-
+    # Public: Gets the combined text of the visible fragments of the email body.
+    #
+    # Returns a String.
     def visible_text
       fragments.select{|f| !f.hidden?}.map{|f| f.to_s}.join("\n").rstrip
     end