Skip to content

Commit

Permalink
📚 Document fields for ThreadMember as methods
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
nevans committed Nov 22, 2022
1 parent e98251c commit 7f99881
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions lib/net/imap/response_data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 7f99881

Please sign in to comment.