diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2012-02-14 14:17:05 +0000 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2012-02-14 14:17:05 +0000 |
| commit | a38e1878aba121364069659068448e4366bd5c2c (patch) | |
| tree | 526710e5614670561347f277bfeabd080c33db5b | |
| parent | 73e6e3f5d45247a9b5891c95ce05c9b195afaeb4 (diff) | |
Document the members of VCard_Field_Address_Map and why it's plural
| -rw-r--r-- | spec/Connection_Interface_Addressing.xml | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/spec/Connection_Interface_Addressing.xml b/spec/Connection_Interface_Addressing.xml index fe3783c2..36080807 100644 --- a/spec/Connection_Interface_Addressing.xml +++ b/spec/Connection_Interface_Addressing.xml @@ -203,11 +203,20 @@ <tp:mapping name="VCard_Field_Address_Map" array-name=""> <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> - <p>A mapping of vCard fields and addresses that repreent - the given contact.</p> + <p>A mapping of vCard fields and addresses equivalent to a + particular contact's protocol identifier. For instance, + on XMPP this would contain <code>x-jabber</code> for all + contacts, and <code>x-facebook-id</code> for contacts on + Facebook's server.</p> </tp:docstring> - <tp:member type="s" name="VCard_Field"/> - <tp:member type="s" name="Address"/> + <tp:member type="s" name="VCard_Field"> + <tp:docstring>A vCard field, such as + <code>x-jabber</code>.</tp:docstring> + </tp:member> + <tp:member type="s" name="Address"> + <tp:docstring>The value of that vCard field for the + contact.</tp:docstring> + </tp:member> </tp:mapping> <tp:contact-attribute name="addresses" type="a{ss}" |