From e500d28c7f6b0dceca6f54373e218b8ffc15e791 Mon Sep 17 00:00:00 2001 From: nick evans Date: Fri, 11 Nov 2022 11:53:00 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Document=20ResponseParser,=20jus?= =?UTF-8?q?t=20a=20little=20bit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lib/net/imap/response_parser.rb | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/lib/net/imap/response_parser.rb b/lib/net/imap/response_parser.rb index ae07a843d..be1a8492b 100644 --- a/lib/net/imap/response_parser.rb +++ b/lib/net/imap/response_parser.rb @@ -5,7 +5,9 @@ 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 @@ -13,6 +15,12 @@ def initialize @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