[Telepathy-commits] [telepathy-glib/master] Add gtk-doc documentation for the Contacs interface and mixin

Sjoerd Simons sjoerd at luon.net
Tue Aug 19 04:25:21 PDT 2008 

20080729190801-93b9a-a658e82abc97e7a9358fe7068e99a39f5e3779f0.gz
---
 docs/reference/telepathy-glib-docs.sgml    |    2 +
 docs/reference/telepathy-glib-sections.txt |   61 ++++++++++++++++++++++++++++
 telepathy-glib/contacts-mixin.c            |    3 +-
 telepathy-glib/contacts-mixin.h            |   10 +++++
 telepathy-glib/extra-gtkdoc.h              |   13 ++++++
 5 files changed, 88 insertions(+), 1 deletions(-)

diff --git a/docs/reference/telepathy-glib-docs.sgml b/docs/reference/telepathy-glib-docs.sgml
index fbbe0b0..48ebe29 100644
--- a/docs/reference/telepathy-glib-docs.sgml
+++ b/docs/reference/telepathy-glib-docs.sgml
@@ -31,6 +31,7 @@
     <xi:include href="xml/connection.xml"/>
     <xi:include href="xml/connection-aliasing.xml"/>
     <xi:include href="xml/connection-avatars.xml"/>
+    <xi:include href="xml/connection-contacts.xml"/>
     <xi:include href="xml/connection-caps.xml"/>
     <xi:include href="xml/connection-simple-presence.xml"/>
     <xi:include href="xml/connection-presence.xml"/>
@@ -64,6 +65,7 @@
     <xi:include href="xml/base-connection-manager.xml"/>
     <xi:include href="xml/base-connection.xml"/>
     <xi:include href="xml/channel-factory-iface.xml"/>
+    <xi:include href="xml/contacts-mixin.xml"/>
     <xi:include href="xml/dbus-properties-mixin.xml"/>
     <xi:include href="xml/presence-mixin.xml"/>
     <xi:include href="xml/properties-mixin.xml"/>
diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib-sections.txt
index 4700dc7..96b19eb 100644
--- a/docs/reference/telepathy-glib-sections.txt
+++ b/docs/reference/telepathy-glib-sections.txt
@@ -43,6 +43,7 @@ tp_base_connection_finish_shutdown
 tp_base_connection_add_interfaces
 tp_base_connection_dbus_request_handles
 TP_BASE_CONNECTION_ERROR_IF_NOT_CONNECTED
+tp_base_connection_register_with_contacts_iface
 <SUBSECTION Standard>
 TP_BASE_CONNECTION
 TP_IS_BASE_CONNECTION
@@ -604,6 +605,18 @@ TP_TYPE_SVC_CONNECTION
 tp_svc_connection_get_type
 TP_SVC_CONNECTION_GET_CLASS
 <SUBSECTION>
+TpSvcConnectionInterfaceContacts
+TpSvcConnectionInterfaceContactsClass
+tp_svc_connection_interface_contacts_implement_inspect_contacts
+tp_svc_connection_interface_contacts_inspect_contacts_impl
+tp_svc_connection_interface_contacts_return_from_inspect_contacts
+<SUBSECTION Standard>
+TP_IS_SVC_CONNECTION_INTERFACE_CONTACTS
+TP_SVC_CONNECTION_INTERFACE_CONTACTS
+TP_SVC_CONNECTION_INTERFACE_CONTACTS_GET_CLASS
+tp_svc_connection_interface_contacts_get_type
+TP_TYPE_SVC_CONNECTION_INTERFACE_CONTACTS
+<SUBSECTION>
 TpSvcConnectionInterfaceSimplePresence
 TpSvcConnectionInterfaceSimplePresenceClass
 tp_svc_connection_interface_simple_presence_emit_presences_changed
@@ -870,6 +883,10 @@ TP_ARRAY_TYPE_CAPABILITY_PAIR_LIST
 TP_STRUCT_TYPE_CONTACT_CAPABILITY
 TP_ARRAY_TYPE_CONTACT_CAPABILITY_LIST
 <SUBSECTION>
+# Connection - Contacts
+TP_HASH_TYPE_CONTACT_ATTRIBUTES_MAP
+TP_HASH_TYPE_SINGLE_CONTACT_ATTRIBUTES_MAP
+<SUBSECTION>
 # Connection - SimplePresence
 TP_HASH_TYPE_SIMPLE_CONTACT_PRESENCES
 TP_HASH_TYPE_SIMPLE_STATUS_SPEC_MAP
@@ -947,6 +964,7 @@ tp_type_dbus_array_uuusa_7bsv_7du
 tp_type_dbus_array_uuuuus
 tp_type_dbus_array_uuuuuu
 tp_type_dbus_array_uv
+tp_type_dbus_hash_ua_7bsv_7d
 tp_type_dbus_hash_s_28ubba_7bss_7d_29
 tp_type_dbus_hash_sa_7bsv_7d
 tp_type_dbus_hash_s_28ubb_29
@@ -1066,6 +1084,36 @@ TP_PROPERTIES_MIXIN
 </SECTION>
 
 <SECTION>
+<INCLUDE>telepathy-glib/contacts-mixin.h</INCLUDE>
+<FILE>contacts-mixin</FILE>
+
+<TITLE>TpContactsMixin</TITLE>
+TpContactsMixin
+TpContactsMixinClass
+tp_contacts_mixin_add_inspectable_iface
+tp_contacts_mixin_class_get_offset_quark
+tp_contacts_mixin_class_init
+tp_contacts_mixin_finalize
+tp_contacts_mixin_get_offset_quark
+tp_contacts_mixin_iface_init
+tp_contacts_mixin_init
+tp_contacts_mixin_set_contact_attribute
+TpContactsMixinGetAttributesFunc
+<SUBSECTION Private>
+TP_CONTACTS_MIXIN_CLASS_OFFSET
+TP_CONTACTS_MIXIN_CLASS_OFFSET_QUARK
+TP_CONTACTS_MIXIN_OFFSET
+TP_CONTACTS_MIXIN_OFFSET_QUARK
+tp_contacts_mixin_class_get_offset_quark
+tp_contacts_mixin_get_offset_quark
+TpContactsMixinClassPrivate
+TpContactsMixinPrivate
+<SUBSECTION Standard>
+TP_CONTACTS_MIXIN_CLASS
+TP_CONTACTS_MIXIN
+</SECTION>
+
+<SECTION>
 <INCLUDE>telepathy-glib/presence-mixin.h</INCLUDE>
 <FILE>presence-mixin</FILE>
 TpPresenceStatusOptionalArgumentSpec
@@ -1087,6 +1135,7 @@ tp_presence_mixin_emit_one_presence_update
 tp_presence_mixin_iface_init
 tp_presence_mixin_simple_presence_iface_init
 tp_presence_mixin_simple_presence_init_dbus_properties
+tp_presence_mixin_simple_presence_register_with_contacts_iface
 <SUBSECTION Private>
 TP_PRESENCE_MIXIN_CLASS_OFFSET_QUARK
 TP_PRESENCE_MIXIN_CLASS_OFFSET
@@ -1473,6 +1522,8 @@ TP_IFACE_CONNECTION_INTERFACE_AVATARS
 TP_IFACE_QUARK_CONNECTION_INTERFACE_AVATARS
 TP_IFACE_CONNECTION_INTERFACE_CAPABILITIES
 TP_IFACE_QUARK_CONNECTION_INTERFACE_CAPABILITIES
+TP_IFACE_CONNECTION_INTERFACE_CONTACTS
+TP_IFACE_QUARK_CONNECTION_INTERFACE_CONTACTS
 TP_IFACE_CONNECTION_INTERFACE_SIMPLE_PRESENCE
 TP_IFACE_QUARK_CONNECTION_INTERFACE_SIMPLE_PRESENCE
 TP_IFACE_CONNECTION_INTERFACE_PRESENCE
@@ -1528,6 +1579,7 @@ tp_iface_quark_channel_type_tubes
 tp_iface_quark_connection
 tp_iface_quark_connection_interface_aliasing
 tp_iface_quark_connection_interface_avatars
+tp_iface_quark_connection_interface_contacts
 tp_iface_quark_connection_interface_capabilities
 tp_iface_quark_connection_interface_simple_presence
 tp_iface_quark_connection_interface_presence
@@ -2025,6 +2077,15 @@ tp_cli_connection_interface_capabilities_signal_callback_capabilities_changed
 </SECTION>
 
 <SECTION>
+<FILE>connection-contacts</FILE>
+<TITLE>connection-contacts</TITLE>
+<INCLUDE>telepathy-glib/connection.h</INCLUDE>
+tp_cli_connection_interface_contacts_call_inspect_contacts
+tp_cli_connection_interface_contacts_callback_for_inspect_contacts
+tp_cli_connection_interface_contacts_run_inspect_contacts
+</SECTION>
+
+<SECTION>
 <FILE>connection-simple-presence</FILE>
 <TITLE>connection-simple-presence</TITLE>
 <INCLUDE>telepathy-glib/connection.h</INCLUDE>
diff --git a/telepathy-glib/contacts-mixin.c b/telepathy-glib/contacts-mixin.c
index 653b449..b5c9d7c 100644
--- a/telepathy-glib/contacts-mixin.c
+++ b/telepathy-glib/contacts-mixin.c
@@ -378,7 +378,8 @@ tp_contacts_mixin_add_inspectable_iface (GObject *obj, const gchar *interface,
  *   TpContactsMixinGetAttributesFunc
  * @handle: Handle to set the attribute on
  * @attribute: attribute name
- * @value: slice allocated GValue containing the value of the attribute
+ * @value: slice allocated GValue containing the value of the attribute,
+ * ownership of the GValue is taken by the mixin
  *
  * Utility function to set attribute for handle to value in the attributes hash
  * as passed to a TpContactsMixinGetAttributesFunc
diff --git a/telepathy-glib/contacts-mixin.h b/telepathy-glib/contacts-mixin.h
index b72533c..1fdc7d9 100644
--- a/telepathy-glib/contacts-mixin.h
+++ b/telepathy-glib/contacts-mixin.h
@@ -33,6 +33,16 @@ typedef struct _TpContactsMixinClassPrivate TpContactsMixinClassPrivate;
 typedef struct _TpContactsMixin TpContactsMixin;
 typedef struct _TpContactsMixinPrivate TpContactsMixinPrivate;
 
+/**
+ * TpContactsMixinGetAttributesFunc:
+ * @obj: An object implementing the presence interface with this mixin
+ * @contacts: The contacts for which attributes are requested
+ * @attributes_hash: hash of handle => hash of attributes, containing all the
+ * contacts in the contacts array
+ *
+ * This function is called to add attributes of contacts
+ *
+ */
 typedef void (*TpContactsMixinGetAttributesFunc) (GObject *obj,
   const GArray *contacts, GHashTable *attributes_hash);
 
diff --git a/telepathy-glib/extra-gtkdoc.h b/telepathy-glib/extra-gtkdoc.h
index 9676983..9607c30 100644
--- a/telepathy-glib/extra-gtkdoc.h
+++ b/telepathy-glib/extra-gtkdoc.h
@@ -398,6 +398,19 @@
  */
 
 /**
+ * SECTION:connection-contacts
+ * @title: Connection Contacts interface
+ * @short_description: client-side wrappers for the Contacts interface
+ * @see_also: #TpConnection
+ *
+ * This interface allows a client to get information from various connection
+ * interfaces in one dbus call.
+ *
+ * This section documents the auto-generated C wrappers for the
+ * Contacts interface, used with #TpConnection objects.
+ */
+
+/**
  * SECTION:connection-simple-presence
  * @title: Connection SimplePresence interface
  * @short_description: client-side wrappers for the SimplePresence interface
-- 
1.5.6.3

More information about the Telepathy-commits mailing list