From 7f998815fb86c49a39ec594538bec25a35ae4187 Mon Sep 17 00:00:00 2001 From: nick evans Date: Mon, 14 Nov 2022 13:11:28 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Document=20fields=20for=20Thread?= =?UTF-8?q?Member=20as=20methods?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Move struct field docs from the class to methods inside the class. * Remove ABNF comments. * Add type information to the call-seq or the method rdoc text. * Link to the data type(s) that are returned, when possible. --- lib/net/imap/response_data.rb | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/lib/net/imap/response_data.rb b/lib/net/imap/response_data.rb index a909f637..b68736d0 100644 --- a/lib/net/imap/response_data.rb +++ b/lib/net/imap/response_data.rb @@ -855,14 +855,19 @@ class ContentDisposition < Struct.new(:dsp_type, :param) # Net::IMAP::ThreadMember represents a thread-node returned # by Net::IMAP#thread. # - # ==== Fields: - # - # seqno:: The sequence number of this message. - # - # children:: An array of Net::IMAP::ThreadMember objects for mail - # items that are children of this in the thread. - # class ThreadMember < Struct.new(:seqno, :children) + ## + # method: seqno + # :call-seq: seqno -> Integer + # + # The message sequence number. + + ## + # method: children + # :call-seq: children -> array of ThreadMember + # + # An array of Net::IMAP::ThreadMember objects for mail items that are + # children of this in the thread. end # Net::IMAP::BodyTypeBasic represents basic body structures of messages.