summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMikhail Zabaluev <mikhail.zabaluev@nokia.com>2010-02-24 18:15:24 +0200
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2010-03-31 13:24:32 +0100
commit28ba4fde160635b37ca2bf381bb6b8dde6543ead (patch)
tree0ae7751ef76197b6ed767d33aa1f5e622b1081c5
parentd89ffcc59c13447c4fc1cfc6567de5864c86e54c (diff)
Improved documentation to TpContactsMixinFillContactAttributesFunc
-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 4dcda66f0..05ca01a3b 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);