/soc/2013/ankitkv/gobjectification: a28ece02876c: Fix some annot...

[Ankit Vani]

Changeset: a28ece02876c5d54cf0236925e3780aa4a31093d
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-09 23:17 +0530
Branch:	 gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/a28ece02876c

Description:

Fix some annotation warnings in finch

diffstat:

 finch/gntblist.h   |  8 +++++---
 finch/gntlog.h     |  2 +-
 finch/gntpounce.h  |  6 +++---
 finch/gntrequest.h |  2 +-
 finch/gntsound.h   |  5 +++--
 finch/gntui.h      |  2 +-
 6 files changed, 14 insertions(+), 11 deletions(-)

diffs (98 lines):

diff --git a/finch/gntblist.h b/finch/gntblist.h
--- a/finch/gntblist.h
+++ b/finch/gntblist.h
@@ -136,12 +136,13 @@ void finch_blist_set_size(int width, int
 
 /**
  * finch_retrieve_user_info:
- * @conn:   The connection to get information fro
+ * @conn:   The connection to get information from
  * @name:   The user to get information about.
  *
  * Get information about a user. Show immediate feedback.
  *
- * Returns:  Returns the ui-handle for the userinfo notification.
+ * Returns: (transfer none): Returns the ui-handle for the userinfo
+ *          notification.
  */
 gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name);
 
@@ -149,7 +150,8 @@ gpointer finch_retrieve_user_info(Purple
  * finch_blist_get_tree:
  *
  * Get the tree list of the buddy list.
- * Returns:  The GntTree widget.
+ *
+ * Returns: (transfer none): The GntTree widget.
  */
 GntTree * finch_blist_get_tree(void);
 
diff --git a/finch/gntlog.h b/finch/gntlog.h
--- a/finch/gntlog.h
+++ b/finch/gntlog.h
@@ -81,7 +81,7 @@ void finch_log_init(void);
  *
  * Returns the GNT log subsystem handle.
  *
- * Returns: The GNT log subsystem handle.
+ * Returns: (transfer none): The GNT log subsystem handle.
  */
 void *finch_log_get_handle(void);
 
diff --git a/finch/gntpounce.h b/finch/gntpounce.h
--- a/finch/gntpounce.h
+++ b/finch/gntpounce.h
@@ -58,9 +58,9 @@ void finch_pounces_manager_hide(void);
 /**
  * finch_pounces_get_handle:
  *
- * Returns the gtkpounces handle
+ * Returns the GNT pounces handle
  *
- * Returns: The handle to the GTK+ pounces system
+ * Returns: (transfer none): The handle to the GNT pounces system
  */
 void *finch_pounces_get_handle(void);
 
@@ -78,4 +78,4 @@ void finch_pounces_init(void);
  */
 void finch_pounces_uninit(void);
 
-#endif /* _PURPLE_GTKPOUNCE_H_ */
+#endif /* _PURPLE_FINCHPOUNCE_H_ */
diff --git a/finch/gntrequest.h b/finch/gntrequest.h
--- a/finch/gntrequest.h
+++ b/finch/gntrequest.h
@@ -72,7 +72,7 @@ void finch_request_save_in_prefs(gpointe
  *
  * Create a widget field for a request-field.
  *
- * Returns: A GntWidget for the request field.
+ * Returns: (transfer full): A GntWidget for the request field.
  */
 GntWidget *finch_request_field_get_widget(PurpleRequestField *field);
 
diff --git a/finch/gntsound.h b/finch/gntsound.h
--- a/finch/gntsound.h
+++ b/finch/gntsound.h
@@ -56,8 +56,9 @@ void finch_sound_set_active_profile(cons
  *
  * Get a list of available sound profiles.
  *
- * Returns: A list of strings denoting sound profile names.
- *         Caller must free the list (but not the data).
+ * Returns: (transfer container) (element-type utf8): A list of strings
+ *          denoting sound profile names. Caller must free the list
+ *          (but not the data).
  */
 GList *finch_sound_get_profiles(void);
 
diff --git a/finch/gntui.h b/finch/gntui.h
--- a/finch/gntui.h
+++ b/finch/gntui.h
@@ -1,4 +1,4 @@
-/**
+/*
  * finch
  *
  * Finch is the legal property of its developers, whose names are too numerous