[geary/wip/491-email-spoofing-case: 2/2] Add API docs to Geary.RFC822.MailboxAddress to clarify escaping

[Michael Gratton <mjog src gnome org>]

commit c67b60fc9e7d9ba183f5d604bcf0f2b38cc1a093
Author: Michael Gratton <mike vee net>
Date:   Wed Jul 17 18:11:23 2019 +1000

    Add API docs to Geary.RFC822.MailboxAddress to clarify escaping

 src/engine/rfc822/rfc822-mailbox-address.vala | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
---
diff --git a/src/engine/rfc822/rfc822-mailbox-address.vala b/src/engine/rfc822/rfc822-mailbox-address.vala
index f4e84fb8..4ab8d21e 100644
--- a/src/engine/rfc822/rfc822-mailbox-address.vala
+++ b/src/engine/rfc822/rfc822-mailbox-address.vala
@@ -152,7 +152,7 @@ public class Geary.RFC822.MailboxAddress :
      *
      * For "Dirk Gently <dirk example com>", this would be "Dirk Gently".
      *
-     * The returned value has been decoded into UTF-8.
+     * The returned value has been unquoted and decoded into UTF-8.
      */
     public string? name { get; private set; }
 
@@ -191,6 +191,13 @@ public class Geary.RFC822.MailboxAddress :
     public string address { get; private set; }
 
 
+    /**
+     * Constructs a new mailbox address from unquoted, decoded parts.
+     *
+     * The given name (if any) and address parts will be used
+     * verbatim, and quoted or encoded if needed when serialising to
+     * an RFC 833 mailbox address string.
+     */
     public MailboxAddress(string? name, string address) {
         this.name = name;
         this.source_route = null;