[folks] core: Expand the documentation of EmailDetails.email_addresses



commit 758aa57c0f5b6acad9d6f5ff056265f97c06ad12
Author: Philip Withnall <philip tecnocode co uk>
Date:   Tue Aug 9 12:49:31 2011 +0200

    core: Expand the documentation of EmailDetails.email_addresses

 folks/email-details.vala |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/folks/email-details.vala b/folks/email-details.vala
index 4838bed..9d58127 100644
--- a/folks/email-details.vala
+++ b/folks/email-details.vala
@@ -32,6 +32,10 @@ public interface Folks.EmailDetails : Object
   /**
    * The email addresses of the contact.
    *
+   * Each of the { link FieldDetails.value}s in this property contains just an
+   * e-mail address (e.g. âfoo bar comâ), rather than any other way of
+   * formatting an e-mail address (such as âJohn Smith <foo bar com>â).
+   *
    * @since 0.5.1
    */
   public abstract Set<FieldDetails> email_addresses { get; set; }



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