📚 Document ResponseParser, just a little bit

Author: nevans

lib/net/imap/response_parser.rb

@@ -5,14 +5,22 @@
 module Net
   class IMAP < Protocol
 
-    class ResponseParser # :nodoc:
+    # Parses an \IMAP server response.
+    class ResponseParser
+      # :call-seq: Net::IMAP::ResponseParser.new -> Net::IMAP::ResponseParser
       def initialize
         @str = nil
         @pos = nil
         @lex_state = nil
         @token = nil
       end
 
+      # :call-seq:
+      #   parse(str) -> ContinuationRequest
+      #   parse(str) -> UntaggedResponse
+      #   parse(str) -> TaggedResponse
+      #
+      # Raises ResponseParseError for unparsable strings.
       def parse(str)
         @str = str
         @pos = 0
@@ -23,6 +31,8 @@ def parse(str)
 
       private
 
+      # :stopdoc:
+
       EXPR_BEG          = :EXPR_BEG
       EXPR_DATA         = :EXPR_DATA
       EXPR_TEXT         = :EXPR_TEXT