From: Jonny Lamb <jonny.lamb@collabora.co.uk>
Date: Thu, 23 Apr 2009 09:03:06 +0000 (+0100)
Subject: Misc. gtk-doc updates, including being more explicit about refs.
X-Git-Url: https://git.0d.be/?p=empathy.git;a=commitdiff_plain;h=56beb181035248b4aff6927b3397708755ce6588;hp=-c

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

Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
---

56beb181035248b4aff6927b3397708755ce6588
diff --git a/libempathy-gtk/empathy-account-chooser.c b/libempathy-gtk/empathy-account-chooser.c
index aa6cf29e..5d11e8e1 100644
--- a/libempathy-gtk/empathy-account-chooser.c
+++ b/libempathy-gtk/empathy-account-chooser.c
@@ -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)
diff --git a/libempathy-gtk/empathy-contact-selector.c b/libempathy-gtk/empathy-contact-selector.c
index a51d8d3f..f4a302c5 100644
--- a/libempathy-gtk/empathy-contact-selector.c
+++ b/libempathy-gtk/empathy-contact-selector.c
@@ -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
  */
diff --git a/libempathy-gtk/empathy-contact-widget.h b/libempathy-gtk/empathy-contact-widget.h
index db739ad1..0da5580a 100644
--- a/libempathy-gtk/empathy-contact-widget.h
+++ b/libempathy-gtk/empathy-contact-widget.h
@@ -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
 {
diff --git a/libempathy-gtk/empathy-profile-chooser.c b/libempathy-gtk/empathy-profile-chooser.c
index 49595616..10eb3791 100644
--- a/libempathy-gtk/empathy-profile-chooser.c
+++ b/libempathy-gtk/empathy-profile-chooser.c
@@ -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
  */