aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Kerr <charles.kerr@canonical.com>2013-04-18 12:24:58 -0500
committerCharles Kerr <charles.kerr@canonical.com>2013-04-18 12:24:58 -0500
commit460b015be860290cf06e9e08a99a51c52c770717 (patch)
tree34cd2dd8348d7bea6e54d64755d0e600cec10379
parent29befc58e1f1fd61d4d6d1a6db024d32182f7488 (diff)
downloadayatana-indicator-session-460b015be860290cf06e9e08a99a51c52c770717.tar.gz
ayatana-indicator-session-460b015be860290cf06e9e08a99a51c52c770717.tar.bz2
ayatana-indicator-session-460b015be860290cf06e9e08a99a51c52c770717.zip
better documentation for indicator_session_users_get_keys() and indicator_session_users_get_user()
-rw-r--r--src/users.h16
1 files changed, 13 insertions, 3 deletions
diff --git a/src/users.h b/src/users.h
index 31ee39e..f2d7404 100644
--- a/src/users.h
+++ b/src/users.h
@@ -124,11 +124,21 @@ void indicator_session_users_notify_is_live_session (IndicatorSessionUsers * sel
gboolean indicator_session_users_is_live_session (IndicatorSessionUsers * users);
-/* get a list of user keys */
+/**
+ * Get a list of user keys.
+ *
+ * Return value: (transfer full): a NULL-terminated array of user keys.
+ * Free with g_strfreev() when done.
+ */
GStrv indicator_session_users_get_keys (IndicatorSessionUsers * users);
-/* get information about a particular user.
- call indicator_session_user_free() when done with the returned struct. */
+/**
+ * Get information about a particular user.
+ *
+ * Return value: (transfer full): an IndicatorSessionUser struct
+ * populated with information about the specified user.
+ * Free with indicator_session_user_free() when done.
+ */
IndicatorSessionUser *
indicator_session_users_get_user (IndicatorSessionUsers * users,
const gchar * key);