[totem] Add missing introspection annotations



commit 921b3b789aac7279beb1b886279c5e9788377778
Author: Philip Withnall <philip tecnocode co uk>
Date:   Sun Sep 19 13:59:17 2010 +0100

    Add missing introspection annotations

 src/plugins/totem-dirs.c |    6 +++---
 src/totem-interface.c    |   30 ++++++++++++++++++++++++++++++
 src/totem-object.c       |    4 ++--
 src/totem-video-list.c   |    2 +-
 4 files changed, 36 insertions(+), 6 deletions(-)
---
diff --git a/src/plugins/totem-dirs.c b/src/plugins/totem-dirs.c
index f5604a8..a87208b 100644
--- a/src/plugins/totem-dirs.c
+++ b/src/plugins/totem-dirs.c
@@ -53,7 +53,7 @@
  *
  * Return a %NULL-terminated array of paths to directories which can contain Totem plugins. This respects the GSettings disable_user_plugins setting.
  *
- * Return value: a %NULL-terminated array of paths to plugin directories
+ * Return value: (transfer full): a %NULL-terminated array of paths to plugin directories
  *
  * Since: 2.90.0
  **/
@@ -162,14 +162,14 @@ totem_plugin_find_file (const char *plugin_name,
  * @name: interface filename
  * @fatal: %TRUE if it's a fatal error if the interface can't be loaded
  * @parent: (allow-none): the interface's parent #GtkWindow
- * @user_data: a pointer to be passed to each signal handler in the interface when they're called
+ * @user_data: (allow-none): a pointer to be passed to each signal handler in the interface when they're called
  *
  * Loads an interface file (GtkBuilder UI file) for a plugin, given its filename and
  * assuming it's installed in the plugin's data directory.
  *
  * This should be used instead of attempting to load interfaces manually in plugins.
  *
- * Return value: the #GtkBuilder instance for the interface
+ * Return value: (transfer full): the #GtkBuilder instance for the interface
  **/
 GtkBuilder *
 totem_plugin_load_interface (const char *plugin_name,
diff --git a/src/totem-interface.c b/src/totem-interface.c
index f60a1bb..1386b1c 100644
--- a/src/totem-interface.c
+++ b/src/totem-interface.c
@@ -156,6 +156,17 @@ totem_interface_error_with_link (const char *title, const char *reason,
 	gtk_window_present (GTK_WINDOW (error_dialog));
 }
 
+/**
+ * totem_interface_load:
+ * @name: the #GtkBuilder UI file to load
+ * @fatal: %TRUE if errors loading the file should be fatal, %FALSE otherwise
+ * @parent: (allow-none): the parent window to use when displaying error dialogues, or %NULL
+ * @user_data: (allow-none): the user data to pass to gtk_builder_connect_signals(), or %NULL
+ *
+ * Load a #GtkBuilder UI file with the given name and return the #GtkBuilder instance for it. If loading the file fails, an error dialogue is shown.
+ *
+ * Return value: (transfer full): the loaded #GtkBuilder object, or %NULL
+ */
 GtkBuilder *
 totem_interface_load (const char *name, gboolean fatal, GtkWindow *parent, gpointer user_data)
 {
@@ -183,6 +194,17 @@ totem_interface_load (const char *name, gboolean fatal, GtkWindow *parent, gpoin
 	return builder;
 }
 
+/**
+ * totem_interface_load_with_full_path:
+ * @filename: the #GtkBuilder UI file path to load
+ * @fatal: %TRUE if errors loading the file should be fatal, %FALSE otherwise
+ * @parent: (allow-none): the parent window to use when displaying error dialogues, or %NULL
+ * @user_data: (allow-none): the user data to pass to gtk_builder_connect_signals(), or %NULL
+ *
+ * Load a #GtkBuilder UI file from the given path and return the #GtkBuilder instance for it. If loading the file fails, an error dialogue is shown.
+ *
+ * Return value: (transfer full): the loaded #GtkBuilder object, or %NULL
+ */
 GtkBuilder *
 totem_interface_load_with_full_path (const char *filename, gboolean fatal, 
 				     GtkWindow *parent, gpointer user_data)
@@ -215,6 +237,14 @@ totem_interface_load_with_full_path (const char *filename, gboolean fatal,
 	return builder;
 }
 
+/**
+ * totem_interface_load_pixbuf:
+ * @name: the image file name
+ *
+ * Load the image called @name in the directory given by totem_interface_get_full_path() into a #GdkPixbuf.
+ *
+ * Return value: (transfer full): the loaded pixbuf, or %NULL
+ */
 GdkPixbuf*
 totem_interface_load_pixbuf (const char *name)
 {
diff --git a/src/totem-object.c b/src/totem-object.c
index c7e0f38..bfe3c84 100644
--- a/src/totem-object.c
+++ b/src/totem-object.c
@@ -398,7 +398,7 @@ totem_object_plugins_shutdown (TotemObject *totem)
  *
  * Gets Totem's main window and increments its reference count.
  *
- * Return value: Totem's main window
+ * Return value: (transfer full): Totem's main window
  **/
 GtkWindow *
 totem_object_get_main_window (TotemObject *totem)
@@ -432,7 +432,7 @@ totem_object_get_ui_manager (TotemObject *totem)
  *
  * Gets Totem's video widget and increments its reference count.
  *
- * Return value: Totem's video widget
+ * Return value: (transfer full): Totem's video widget
  **/
 GtkWidget *
 totem_get_video_widget (TotemObject *totem)
diff --git a/src/totem-video-list.c b/src/totem-video-list.c
index f9d8a84..a485f2d 100644
--- a/src/totem-video-list.c
+++ b/src/totem-video-list.c
@@ -560,7 +560,7 @@ error:
  *
  * Returns the #GtkUIManager in use by @self.
  *
- * Return value: @self's #GtkUIManager
+ * Return value: (transfer none): @self's #GtkUIManager
  **/
 GtkUIManager *
 totem_video_list_get_ui_manager (TotemVideoList *self)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]