Skip to content

Commit f807641

Browse files
committed
📚 Document fields for MailboxACLItem 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 92ee460 commit f807641

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

lib/net/imap/response_data.rb

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -354,21 +354,29 @@ class MailboxQuotaRoot < Struct.new(:mailbox, :quotaroots)
354354

355355
# Net::IMAP::MailboxACLItem represents the response from GETACL.
356356
#
357-
# acl_data ::= "ACL" SPACE mailbox *(SPACE identifier SPACE rights)
358-
#
359-
# identifier ::= astring
360-
#
361-
# rights ::= astring
362-
#
363-
# ==== Fields:
364-
#
365-
# user:: Login name that has certain rights to the mailbox
366-
# that was specified with the getacl command.
367-
#
368-
# rights:: The access rights the indicated user has to the
369-
# mailbox.
357+
# Net::IMAP#getacl returns an array of MailboxACLItem objects.
370358
#
359+
# ==== Required capability
360+
# +ACL+ - described in [ACL[https://tools.ietf.org/html/rfc4314]]
371361
class MailboxACLItem < Struct.new(:user, :rights, :mailbox)
362+
##
363+
# method: mailbox
364+
# :call-seq: mailbox -> string
365+
#
366+
# The mailbox to which the indicated #user has the specified #rights.
367+
368+
##
369+
# method: user
370+
# :call-seq: user -> string
371+
#
372+
# Login name that has certain #rights to the #mailbox that was specified
373+
# with the getacl command.
374+
375+
##
376+
# method: rights
377+
# :call-seq: rights -> string
378+
#
379+
# The access rights the indicated #user has to the #mailbox.
372380
end
373381

374382
# Net::IMAP::Namespace represents a single [RFC-2342] namespace.

0 commit comments

Comments
 (0)