From e98251cc3ea079092a2bbf56d18ec08408dd6374 Mon Sep 17 00:00:00 2001 From: nick evans Date: Mon, 14 Nov 2022 13:10:41 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Document=20fields=20for=20Conten?= =?UTF-8?q?tDisposition=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. * Link to the appropriate RFC(s). --- lib/net/imap/response_data.rb | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/lib/net/imap/response_data.rb b/lib/net/imap/response_data.rb index 94451422..a909f637 100644 --- a/lib/net/imap/response_data.rb +++ b/lib/net/imap/response_data.rb @@ -834,17 +834,22 @@ class Address < Struct.new(:name, :route, :mailbox, :host) # syntax. end - # # Net::IMAP::ContentDisposition represents Content-Disposition fields. # - # ==== Fields: - # - # dsp_type:: Returns the disposition type. - # - # param:: Returns a hash that represents parameters of the Content-Disposition - # field. - # class ContentDisposition < Struct.new(:dsp_type, :param) + ## + # method: dsp_type + # :call-seq: dsp_type -> string + # + # Returns the content disposition type, as defined by + # [DISPOSITION[https://tools.ietf.org/html/rfc2183]]. + + ## + # method: param + # :call-seq: param -> hash + # + # Returns a hash representing parameters of the Content-Disposition + # field, as defined by [DISPOSITION[https://tools.ietf.org/html/rfc2183]]. end # Net::IMAP::ThreadMember represents a thread-node returned