[Telepathy-commits] [telepathy-spec/master] ContactInfo2: move Contact_Info struct documentation to its definition

[Will Thompson]

---
 spec/Connection_Interface_Contact_Info2.xml |   35 +++++++++++++++++++-------
 1 files changed, 25 insertions(+), 10 deletions(-)

diff --git a/spec/Connection_Interface_Contact_Info2.xml b/spec/Connection_Interface_Contact_Info2.xml
index d93638e..51623e6 100644
--- a/spec/Connection_Interface_Contact_Info2.xml
+++ b/spec/Connection_Interface_Contact_Info2.xml
@@ -57,9 +57,29 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
     </tp:enum>
 
     <tp:struct name="Contact_Info" array-name="Contact_Info_List">
-      <tp:member type="s" name="Field_Name"/>
-      <tp:member type="au" tp:type="Contact_Info_Field_Type[]" name="Type"/>
-      <tp:member type="s" name="Field_Value"/>
+      <tp:docstring>
+        Represents one piece of information about a contact, loosely following
+        a single vCard field.
+      </tp:docstring>
+      <tp:member type="s" name="Field_Name">
+        <tp:docstring>
+          The name of the field.  For simple fields, this is the lowercased
+          name of the corresponding vCard field; components of structured vCard
+          fields are represented by separate fields.  For example, an EMAIL
+          vCard field would be named "email", while the penultimate field of an
+          ADR field would be named "postal-code".
+        </tp:docstring>
+      </tp:member>
+      <tp:member type="au" tp:type="Contact_Info_Field_Type[]" name="Type">
+        <tp:docstring>
+          The set of type modifiers for this field.
+        </tp:docstring>
+      </tp:member>
+      <tp:member type="s" name="Field_Value">
+        <tp:docstring>
+          The field's value.
+        </tp:docstring>
+      </tp:member>
     </tp:struct>
 
     <signal name="GotContactInfo" tp:name-for-bindings="Got_Contact_Info">
@@ -70,13 +90,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
       </arg>
       <arg name="ContactInfo" type="a(saus)" tp:type="Contact_Info[]">
         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-	  An array of structs loosley based on vCard:
-	  <ul>
-	    <li>a field name, same as vCard field for simple fields,
-	      separate field is used to represent component of structured fields</li>
-	    <li>an array of field types</li>
-	    <li>a field value</li>
-	  </ul>
+          An array of fields representing information about this contact.
         </tp:docstring>
       </arg>
       <tp:docstring>
@@ -188,3 +202,4 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
     </tp:docstring>
   </interface>
 </node>
+<!-- vim:set sw=2 sts=2 et ft=xml: -->
-- 
1.5.6.5