[geary/mjog/email-templates: 5/6] Minor doc comment update



commit 1b529d219563c78d71e7cd865a212d45aade2147
Author: Michael Gratton <mike vee net>
Date:   Wed Apr 22 19:09:35 2020 +1000

    Minor doc comment update

 src/engine/imap/response/imap-mailbox-attributes.vala | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
---
diff --git a/src/engine/imap/response/imap-mailbox-attributes.vala 
b/src/engine/imap/response/imap-mailbox-attributes.vala
index 12241f9d..45e6d8d2 100644
--- a/src/engine/imap/response/imap-mailbox-attributes.vala
+++ b/src/engine/imap/response/imap-mailbox-attributes.vala
@@ -55,7 +55,10 @@ public class Geary.Imap.MailboxAttributes : Geary.Imap.Flags {
     }
 
     /**
-     * Returns the special use specified for the mailbox, if any.
+     * Returns the special use specified for the mailbox.
+     *
+     * If no special use is set, returns {@link
+     * Geary.Folder.SpecialUse.NONE}.
      */
     public Geary.Folder.SpecialUse get_special_use() {
         if (contains(MailboxAttribute.XLIST_INBOX))


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]