summaryrefslogtreecommitdiff
path: root/telepathy-glib/contacts-mixin.h
diff options
context:
space:
mode:
authorMikhail Zabaluev <mikhail.zabaluev@nokia.com>2010-02-24 18:15:24 +0200
committerMikhail Zabaluev <mikhail.zabaluev@nokia.com>2010-02-24 18:15:24 +0200
commit44a0fe04add5e633ffb9ee2be869adde435f4d12 (patch)
treed6fa21df11ce7f4dbe48bc719d598efcf26ab8f7 /telepathy-glib/contacts-mixin.h
parent3b65e1e49db3411c281d8bcd4e0aa6de2cd21ed3 (diff)
downloadtelepathy-glib-44a0fe04add5e633ffb9ee2be869adde435f4d12.tar.gz
Improved documentation to TpContactsMixinFillContactAttributesFunc
Diffstat (limited to 'telepathy-glib/contacts-mixin.h')
-rw-r--r--telepathy-glib/contacts-mixin.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/telepathy-glib/contacts-mixin.h b/telepathy-glib/contacts-mixin.h
index 2aad0cc99..24276416b 100644
--- a/telepathy-glib/contacts-mixin.h
+++ b/telepathy-glib/contacts-mixin.h
@@ -35,13 +35,15 @@ typedef struct _TpContactsMixinPrivate TpContactsMixinPrivate;
/**
* TpContactsMixinFillContactAttributesFunc:
- * @obj: An object implementing the presence interface with this mixin
- * @contacts: The contacts for which attributes are requested
+ * @obj: An object implementing the Contacts interface with this mixin
+ * @contacts: The contact handles 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
- *
+ * This function is called to supply contact attributes pertaining to
+ * a particular interface, for a list of contacts.
+ * All the handles in @contacts are guaranteed to be valid and
+ * referenced.
*/
typedef void (*TpContactsMixinFillContactAttributesFunc) (GObject *obj,
const GArray *contacts, GHashTable *attributes_hash);