Provide missing g-i annotations (Bug #14045)

11 files changed, 55 insertions, 49 deletions

diff --git a/thunarx/Makefile.am b/thunarx/Makefile.am
index be5ff4e5..78dda47d 100644
--- a/thunarx/Makefile.am
+++ b/thunarx/Makefile.am
@@ -43,7 +43,6 @@ libthunarx_3_la_SOURCES =						\
 	thunarx-property-page-provider.c				\
 	thunarx-provider-factory.c					\
 	thunarx-provider-module.c					\
-	thunarx-provider-module.h					\
 	thunarx-provider-plugin.c					\
 	thunarx-renamer.c						\
 	thunarx-renamer-provider.c
@@ -119,7 +118,7 @@ Thunarx-3.0.gir: libthunarx-3.la
 Thunarx_3_0_gir_INCLUDES = GObject-2.0 Gtk-3.0
 Thunarx_3_0_gir_CFLAGS = $(INCLUDES)
 Thunarx_3_0_gir_LIBS = libthunarx-3.la
-Thunarx_3_0_gir_FILES = $(libthunarx_headers)
+Thunarx_3_0_gir_FILES = $(libthunarx_3_la_SOURCES)
 INTROSPECTION_GIRS += Thunarx-3.0.gir
 
 girdir = $(datadir)/gir-1.0/
diff --git a/thunarx/thunarx-file-info.c b/thunarx/thunarx-file-info.c
index 74bc420e..ae9f184e 100644
--- a/thunarx/thunarx-file-info.c
+++ b/thunarx/thunarx-file-info.c
@@ -303,8 +303,8 @@ thunarx_file_info_is_directory (ThunarxFileInfo *file_info)
  * returned #GFileInfo object using g_object_unref() when
  * no longer needed.
  *
- * Return value: the #GFileInfo object associated with @file_info,
- *               which MUST be freed using g_object_unref().
+ * Returns: (transfer full): the #GFileInfo object associated with @file_info,
+ *          which MUST be freed using g_object_unref().
  **/
 GFileInfo*
 thunarx_file_info_get_file_info (ThunarxFileInfo *file_info)
@@ -324,10 +324,9 @@ thunarx_file_info_get_file_info (ThunarxFileInfo *file_info)
  * free the returned #GFileInfo object using g_object_unref() when
  * no longer needed.
  *
- * Return value: the #GFileInfo containing information about the
- *               filesystem of @file_info or %NULL if no filesystem
- *               information is available. It MUST be released using
- *               g_object_unref().
+ * Returns: (transfer full): the #GFileInfo containing information about the
+ *          filesystem of @file_info or %NULL if no filesystem information is
+ *          available. It MUST be released using g_object_unref().
  **/
 GFileInfo*
 thunarx_file_info_get_filesystem_info (ThunarxFileInfo *file_info)
@@ -347,8 +346,8 @@ thunarx_file_info_get_filesystem_info (ThunarxFileInfo *file_info)
  * is responsible to release the returned #GFile using g_object_unref()
  * when no longer needed.
  *
- * Return value: the #GFile to which @file_info points. It MUST be
- *               released using g_object_unref().
+ * Returns: (transfer full): the #GFile to which @file_info points. It MUST be
+ *          released using g_object_unref().
  **/
 GFile*
 thunarx_file_info_get_location (ThunarxFileInfo *file_info)
@@ -417,12 +416,12 @@ thunarx_file_info_list_get_type (void)
 
 /**
  * thunarx_file_info_list_copy:
- * @file_infos : a #GList of #ThunarxFileInfo<!---->s.
+ * @file_infos: (element-type ThunarxFileInfo): a #GList of #ThunarxFileInfo<!---->s.
  *
  * Does a deep copy of @file_infos and returns the
  * new list.
  *
- * Return value: a copy of @file_infos.
+ * Returns: (transfer full) (element-type ThunarxFileInfo): a copy of @file_infos.
  **/
 GList*
 thunarx_file_info_list_copy (GList *file_infos)
@@ -443,7 +442,7 @@ thunarx_file_info_list_copy (GList *file_infos)
 
 /**
  * thunarx_file_info_list_free:
- * @file_infos : a #GList of #ThunarxFileInfo<!---->s.
+ * @file_infos: (element-type ThunarxFileInfo): a #GList of #ThunarxFileInfo<!---->s.
  *
  * Frees the resources allocated for the @file_infos
  * list and decreases the reference count on the
diff --git a/thunarx/thunarx-menu-provider.c b/thunarx/thunarx-menu-provider.c
index 597553e5..ffeb1047 100644
--- a/thunarx/thunarx-menu-provider.c
+++ b/thunarx/thunarx-menu-provider.c
@@ -81,9 +81,10 @@ thunarx_menu_provider_get_type (void)
 
 /**
  * thunarx_menu_provider_get_file_menu_items:
- * @provider : a #ThunarxMenuProvider.
- * @window   : the #GtkWindow within which the menu items will be used.
- * @files    : the list of #ThunarxFileInfo<!---->s to which the menu items will be applied.
+ * @provider: a #ThunarxMenuProvider.
+ * @window: the #GtkWindow within which the menu items will be used.
+ * @files: (element-type ThunarxFileInfo): the list of #ThunarxFileInfo<!---->s
+ *         to which the menu items will be applied.
  *
  * Returns the list of #ThunarxMenuItem<!---->s that @provider has to offer for
  * @files.
@@ -102,8 +103,8 @@ thunarx_menu_provider_get_type (void)
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the list of #ThunarxMenuItem<!---->s that @provider has to offer
- *               for @files.
+ * Returns: (transfer full) (element-type ThunarxMenuItem): the list of #ThunarxMenuItem<!---->s
+ *          that @provider has to offer for @files.
  **/
 GList*
 thunarx_menu_provider_get_file_menu_items (ThunarxMenuProvider *provider,
@@ -157,8 +158,8 @@ thunarx_menu_provider_get_file_menu_items (ThunarxMenuProvider *provider,
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the list of #ThunarxMenuItem<!---->s that @provider has to offer
- *               for @folder.
+ * Returns: (transfer full) (element-type ThunarxMenuItem): the list of #ThunarxMenuItem<!---->s
+ *          that @provider has to offer for @folder.
  **/
 GList*
 thunarx_menu_provider_get_folder_menu_items (ThunarxMenuProvider *provider,
@@ -192,11 +193,11 @@ thunarx_menu_provider_get_folder_menu_items (ThunarxMenuProvider *provider,
 
 /**
  * thunarx_menu_provider_get_dnd_menu_items:
- * @provider : a #ThunarxMenuProvider.
- * @window   : the #GtkWindow within which the menu items will be used.
- * @folder   : the folder into which the @files are being dropped
- * @files    : the list of #ThunarxFileInfo<!---->s for the files that are
- *             being dropped to @folder in @window.
+ * @provider: a #ThunarxMenuProvider.
+ * @window: the #GtkWindow within which the menu items will be used.
+ * @folder: the folder into which the @files are being dropped
+ * @files: (element-type ThunarxFileInfo): the list of #ThunarxFileInfo<!---->s
+ *         for the files that are being dropped to @folder in @window.
  *
  * Returns the list of #ThunarxMenuItem<!---->s that @provider has to offer for
  * dropping the @files into the @folder. For example, the thunar-archive-plugin
@@ -217,8 +218,8 @@ thunarx_menu_provider_get_folder_menu_items (ThunarxMenuProvider *provider,
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the list of #ThunarxMenuItem<!---->s that @provider has to offer
- *               for dropping @files to @folder.
+ * Returns: (transfer full) (element-type ThunarxMenuItem): the list of #ThunarxMenuItem<!---->s
+ *          that @provider has to offer for dropping @files to @folder.
  *
  * Since: 0.4.1
  **/
diff --git a/thunarx/thunarx-preferences-provider.c b/thunarx/thunarx-preferences-provider.c
index 249c7f87..f5cc25f8 100644
--- a/thunarx/thunarx-preferences-provider.c
+++ b/thunarx/thunarx-preferences-provider.c
@@ -97,8 +97,9 @@ thunarx_preferences_provider_get_type (void)
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the list of #ThunarxMenuItem<!---->s that @provider has
- *               to offer as preferences within @window.
+ * Returns: (transfer full) (element-type ThunarxMenuItem): the list of
+ *          #ThunarxMenuItem<!---->s that @provider has to offer as preferences
+ *          within @window.
  **/
 GList*
 thunarx_preferences_provider_get_menu_items (ThunarxPreferencesProvider *provider,
diff --git a/thunarx/thunarx-private.c b/thunarx/thunarx-private.c
index 23b72fa6..049f41f4 100644
--- a/thunarx/thunarx-private.c
+++ b/thunarx/thunarx-private.c
@@ -37,7 +37,12 @@ static GQuark thunarx_object_list_quark = 0;
 
 
 
-/* takes a reference on target for each object in object_list */
+/**
+ * thunarx_object_list_take_reference:
+ * @object_list: (element-type GObject): a #GList of #GObject<!---->s.
+ * 
+ * takes a reference on target for each object in object_list
+ **/
 void
 thunarx_object_list_take_reference (GList   *object_list,
                                     gpointer target)
@@ -87,4 +92,3 @@ thunarx_param_spec_get_option_name (GParamSpec *pspec)
 
   return name;
 }
-
diff --git a/thunarx/thunarx-property-page-provider.c b/thunarx/thunarx-property-page-provider.c
index 36ca5457..0ed68a10 100644
--- a/thunarx/thunarx-property-page-provider.c
+++ b/thunarx/thunarx-property-page-provider.c
@@ -66,8 +66,9 @@ thunarx_property_page_provider_get_type (void)
 
 /**
  * thunarx_property_page_provider_get_pages:
- * @provider : a #ThunarxPropertyPageProvider.
- * @files    : the list of #ThunarxFileInfo<!---->s for which a properties dialog will be displayed.
+ * @provider: a #ThunarxPropertyPageProvider.
+ * @files: (element-type ThunarxFileInfo): the list of #ThunarxFileInfo<!---->s
+ *         for which a properties dialog will be displayed.
  *
  * Returns the list of #ThunarxPropertyPage<!---->s that @provider has to offer for @files.
  *
@@ -108,8 +109,8 @@ thunarx_property_page_provider_get_type (void)
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the list of #ThunarxPropertyPage<!---->s that @provider has to offer
- *               for @files.
+ * Returns: (transfer full) (element-type ThunarxPropertyPage): the list of
+ *          #ThunarxPropertyPage<!---->s that @provider has to offer for @files.
  **/
 GList*
 thunarx_property_page_provider_get_pages (ThunarxPropertyPageProvider *provider,
diff --git a/thunarx/thunarx-property-page.c b/thunarx/thunarx-property-page.c
index a62bddff..97bf5fc3 100644
--- a/thunarx/thunarx-property-page.c
+++ b/thunarx/thunarx-property-page.c
@@ -309,7 +309,7 @@ thunarx_property_page_set_label (ThunarxPropertyPage *property_page,
  * Returns the label widget for the @property_page. See
  * thunarx_property_page_set_label_widget().
  *
- * return value: the label widget or %NULL if there is none.
+ * Returns: (transfer none): the label widget or %NULL if there is none.
  **/
 GtkWidget*
 thunarx_property_page_get_label_widget (ThunarxPropertyPage *property_page)
diff --git a/thunarx/thunarx-provider-factory.c b/thunarx/thunarx-provider-factory.c
index 6707b6d9..7764b55f 100644
--- a/thunarx/thunarx-provider-factory.c
+++ b/thunarx/thunarx-provider-factory.c
@@ -251,8 +251,8 @@ thunarx_provider_factory_timer_destroy (gpointer user_data)
  * The caller is responsible to free the returned object
  * using g_object_unref() when no longer needed.
  *
- * Return value: a reference to the default
- *               #ThunarxProviderFactory instance.
+ * Returns: (transfer full): a reference to the default #ThunarxProviderFactory
+ *          instance.
  **/
 ThunarxProviderFactory*
 thunarx_provider_factory_get_default (void)
@@ -289,7 +289,7 @@ thunarx_provider_factory_get_default (void)
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the of providers for @type.
+ * Returns: (transfer full) (element-type GObject): the of providers for @type.
  **/
 GList*
 thunarx_provider_factory_list_providers (ThunarxProviderFactory *factory,
diff --git a/thunarx/thunarx-renamer-provider.c b/thunarx/thunarx-renamer-provider.c
index 21c8487f..4094a5fd 100644
--- a/thunarx/thunarx-renamer-provider.c
+++ b/thunarx/thunarx-renamer-provider.c
@@ -90,7 +90,7 @@ thunarx_renamer_provider_get_type (void)
  * g_list_free_full (list, g_object_unref);
  * </programlisting></informalexample>
  *
- * Return value: the list of #ThunarxRenamer<!---->s provided by the
+ * Returns: (transfer full) (element-type ThunarxRenamer): the list of #ThunarxRenamer<!---->s provided by the
  *               specified @provider.
  **/
 GList*
diff --git a/thunarx/thunarx-renamer.c b/thunarx/thunarx-renamer.c
index 6fa35601..715dbd39 100644
--- a/thunarx/thunarx-renamer.c
+++ b/thunarx/thunarx-renamer.c
@@ -522,7 +522,7 @@ thunarx_renamer_set_name (ThunarxRenamer *renamer,
  *            determined.
  * @text    : the part of the filename to which the
  *            @renamer should be applied.
- * @idx     : the index of the file in the list, used
+ * @index   : the index of the file in the list, used
  *            for renamers that work on numbering.
  *
  * Determines the replacement for @text (which is the relevant
@@ -538,12 +538,12 @@ gchar*
 thunarx_renamer_process (ThunarxRenamer  *renamer,
                          ThunarxFileInfo *file,
                          const gchar     *text,
-                         guint            idx)
+                         guint            index)
 {
   g_return_val_if_fail (THUNARX_IS_FILE_INFO (file), NULL);
   g_return_val_if_fail (THUNARX_IS_RENAMER (renamer), NULL);
   g_return_val_if_fail (g_utf8_validate (text, -1, NULL), NULL);
-  return (*THUNARX_RENAMER_GET_CLASS (renamer)->process) (renamer, file, text, idx);
+  return (*THUNARX_RENAMER_GET_CLASS (renamer)->process) (renamer, file, text, index);
 }
 
 
@@ -623,9 +623,9 @@ thunarx_renamer_save (ThunarxRenamer *renamer,
 
 /**
  * thunarx_renamer_get_menu_items:
- * @renamer : a #ThunarxRenamer.
- * @window  : a #GtkWindow or %NULL.
- * @files   : a #GList of #ThunarxFileInfo<!---->s.
+ * @renamer: a #ThunarxRenamer.
+ * @window: a #GtkWindow or %NULL.
+ * @files: (element-type ThunarxFileInfo): a #GList of #ThunarxFileInfo<!---->s.
  *
  * Returns the list of #ThunarxMenuItem<!---->s provided by @renamer for
  * the given list of @files. By default, this method returns %NULL
@@ -692,8 +692,9 @@ thunarx_renamer_save (ThunarxRenamer *renamer,
  * forget to release the weak reference if @window survived the lifetime
  * of your menu item (which is likely to be the case in most situations).
  *
- * Return value: the list of #ThunarxMenuItem<!---->s provided by @renamer
- *               for the given list of @files.
+ * Returns: (transfer full) (element-type ThunarxMenuItem): the list of
+ *          #ThunarxMenuItem<!---->s provided by @renamer for the given list of
+ *          @files.
  **/
 GList*
 thunarx_renamer_get_menu_items (ThunarxRenamer *renamer,
diff --git a/thunarx/thunarx-renamer.h b/thunarx/thunarx-renamer.h
index f1050fb4..2a52d40f 100644
--- a/thunarx/thunarx-renamer.h
+++ b/thunarx/thunarx-renamer.h
@@ -117,7 +117,7 @@ void         thunarx_renamer_set_name       (ThunarxRenamer   *renamer,
 gchar       *thunarx_renamer_process        (ThunarxRenamer   *renamer,
                                              ThunarxFileInfo  *file,
                                              const gchar      *text,
-                                             guint             idx) G_GNUC_MALLOC;
+                                             guint             index) G_GNUC_MALLOC;
 
 void         thunarx_renamer_load           (ThunarxRenamer   *renamer,
                                              GHashTable       *settings);