Skip to content

Commit 7f99881

Browse files
committed
📚 Document fields for ThreadMember as methods
* 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.
1 parent e98251c commit 7f99881

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

lib/net/imap/response_data.rb

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -855,14 +855,19 @@ class ContentDisposition < Struct.new(:dsp_type, :param)
855855
# Net::IMAP::ThreadMember represents a thread-node returned
856856
# by Net::IMAP#thread.
857857
#
858-
# ==== Fields:
859-
#
860-
# seqno:: The sequence number of this message.
861-
#
862-
# children:: An array of Net::IMAP::ThreadMember objects for mail
863-
# items that are children of this in the thread.
864-
#
865858
class ThreadMember < Struct.new(:seqno, :children)
859+
##
860+
# method: seqno
861+
# :call-seq: seqno -> Integer
862+
#
863+
# The message sequence number.
864+
865+
##
866+
# method: children
867+
# :call-seq: children -> array of ThreadMember
868+
#
869+
# An array of Net::IMAP::ThreadMember objects for mail items that are
870+
# children of this in the thread.
866871
end
867872

868873
# Net::IMAP::BodyTypeBasic represents basic body structures of messages.

0 commit comments

Comments
 (0)