Commit 56beb181 authored by Jonny Lamb's avatar Jonny Lamb

Misc. gtk-doc updates, including being more explicit about refs.

Signed-off-by: 's avatarJonny Lamb <jonny.lamb@collabora.co.uk>
parent 78f1e5ce
......@@ -254,7 +254,7 @@ empathy_account_chooser_new (void)
*
* Returns the account which is currently selected in the chooser or %NULL
* if there is no account selected. The #McAccount returned should be
* unrefed when finished with.
* unrefed with g_object_unref() when finished with.
*
* Return value: a new ref to the #McAccount currently selected, or %NULL.
*/
......@@ -284,9 +284,12 @@ empathy_account_chooser_dup_account (EmpathyAccountChooser *chooser)
* empathy_account_chooser_get_connection:
* @chooser: an #EmpathyAccountChooser
*
* Returns the #TpConnection associated with the account currently selected.
* Returns a borrowed reference to the #TpConnection associated with the
* account currently selected. The caller must reference the returned object with
* g_object_ref() if it will be kept
*
* Return value: the #TpConnection associated with the account curently selected.
* Return value: a borrowed reference to the #TpConnection associated with the
* account curently selected.
*/
TpConnection *
empathy_account_chooser_get_connection (EmpathyAccountChooser *chooser)
......
......@@ -372,8 +372,8 @@ empathy_contact_selector_new (EmpathyContactList *contact_list)
* @selector: An #EmpathyContactSelector
*
* Returns a new reference to the contact which is currently selected in
* @selector, or %NULL if there is no contact selected. The contact should
* be unrefed with g_object_unref() when finished with.
* @selector, or %NULL if there is no contact selected. The returned contact
* should be unrefed with g_object_unref() when finished with.
*
* Return value: A new reference to the contact currently selected, or %NULL
*/
......
......@@ -47,8 +47,8 @@ G_BEGIN_DECLS
* @EMPATHY_CONTACT_WIDGET_FOR_TOOLTIP: Make widgets more designed for a tooltip.
* For example, make widgets not selectable.
*
* Options to instruct the #EmpathyContactWidget what features should be
* enabled.
* Flags used when creating an #EmpathyContactWidget to specify which features
* should be available.
*/
typedef enum
{
......
......@@ -51,7 +51,8 @@ enum {
* empathy_profile_chooser_dup_selected:
* @widget: an #EmpathyProfileChooser
*
* Returns a new reference to the selected #McProfile in @widget.
* Returns a new reference to the selected #McProfile in @widget. The returned
* #McProfile should be unrefed with g_object_unref() when finished with.
*
* Return value: a new reference to the selected #McProfile
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment