From 460b015be860290cf06e9e08a99a51c52c770717 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Thu, 18 Apr 2013 12:24:58 -0500 Subject: better documentation for indicator_session_users_get_keys() and indicator_session_users_get_user() --- src/users.h | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) (limited to 'src/users.h') 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); -- cgit v1.2.3