eds: Clarify mapping between properties and vCard fields in EDS
authorPhilip Withnall <philip@tecnocode.co.uk>
Fri, 21 Jun 2013 23:01:07 +0000 (00:01 +0100)
committerPhilip Withnall <philip@tecnocode.co.uk>
Fri, 21 Jun 2013 23:01:07 +0000 (00:01 +0100)
backends/eds/lib/edsf-persona.vala

index 8cba695..5f3ff0a 100644 (file)
@@ -172,6 +172,8 @@ public class Edsf.Persona : Folks.Persona,
 
   /**
    * {@inheritDoc}
+   *
+   * This is stored in the X-FOLKS-WEB-SERVICES-IDS vCard field in EDS.
    */
   [CCode (notify = false)]
   public MultiMap<string, WebServiceFieldDetails> web_service_addresses
@@ -200,6 +202,8 @@ public class Edsf.Persona : Folks.Persona,
 
   /**
    * IDs used to link {@link Edsf.Persona}s.
+   *
+   * This is stored in the X-FOLKS-CONTACTS-IDS vCard field in EDS.
    */
   [CCode (notify = false)]
   public Set<string> local_ids
@@ -499,6 +503,9 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * {@inheritDoc}
    *
+   * This is stored in the {@link Edsf.Persona.gender_attribute_name} vCard
+   * field in EDS.
+   *
    * @since 0.6.0
    */
   [CCode (notify = false)]
@@ -523,6 +530,8 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * {@inheritDoc}
    *
+   * This is stored in the X-URIS vCard field in EDS.
+   *
    * @since 0.6.0
    */
   [CCode (notify = false)]
@@ -756,6 +765,8 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * {@inheritDoc}
    *
+   * This is stored in the X-ROLES vCard field in EDS.
+   *
    * @since 0.6.2
    */
   [CCode (notify = false)]
@@ -785,6 +796,8 @@ public class Edsf.Persona : Folks.Persona,
   /**
    * Whether this contact is a user-defined favourite.
    *
+   * This is stored in the X-FOLKS-FAVOURITE vCard field in EDS.
+   *
    * @since 0.6.5
    */
   [CCode (notify = false)]
@@ -848,6 +861,8 @@ public class Edsf.Persona : Folks.Persona,
    * The complete set of system group identifiers the contact belongs to.
    * See {@link Persona.change_system_groups} for details.
    *
+   * This is stored in the X-GOOGLE-SYSTEM-GROUP-IDS vCard field in EDS.
+   *
    * @since 0.9.0
    */
   [CCode (notify = false)]