Merge lp:~gue5t/midori/gir-2 into lp:midori

[gue5t gue5t]

Fix some symbol names and transfer annotations in doc comments

This fixes several wrong or missing parts of our documentation which the g-ir-scanner didn't like. No changes to executable code.

[Cris Dywan (kalikiana)]

gir doesn't seem too happy with this

katze/katze-item.c:278: Warning: Katze: katze_item_new: return value: Invalid non-constant of bare structure or union; register as boxed type (skip)

review: Needs Fixing

[gue5t gue5t (gue5t)]

> gir doesn't seem too happy with this
>
> katze/katze-item.c:278: Warning: Katze: katze_item_new: return value: Invalid
> non-constant of bare structure or union; register as boxed type (skip)

I asked in #introspection and apparently g-ir-scanner does not intuit which types are GObject classes from source code (G_DEFINE_TYPE) but requires to build a binary and run it to dump introspection data, so in our current build setup (running g-ir-scanner on source rather than an introspection dump) it doesn't realize that KatzeItem is a GObject class. This isn't, as far as I know, a sign that our annotations are incorrect. Ultimately we need to set up the buildsystem stuff to produce the introspection binary, but in the meantime I'd like to get this merged just so we have more annotations.

[Cris Dywan (kalikiana)]

review: Approve

=== modified file 'katze/katze-arrayaction.c'
--- katze/katze-arrayaction.c	2013-12-26 17:41:17 +0000
+++ katze/katze-arrayaction.c	2014-05-20 02:22:37 +0000
@@ -695,7 +695,7 @@
  * Note that the label is reasonably ellipsized for you,
  * much like katze_image_menu_item_new_ellipsized().
  *
- * Return value: a new tool item
+ * Return value: (transfer full): a new tool item
  **/
 GtkToolItem*
 katze_array_action_create_tool_item_for (KatzeArrayAction* array_action,
@@ -802,6 +802,14 @@
         (action, proxy);
 }
 
+/**
+ * katze_array_action_get_array:
+ * @array_action: a #KatzeArrayAction
+ *
+ * Obtain the array which backs the array action.
+ *
+ * Return value: (transfer none): the KatzeArray used by @array_action
+ **/
 KatzeArray*
 katze_array_action_get_array (KatzeArrayAction* array_action)
 {
 
=== modified file 'katze/katze-cellrenderercomboboxtext.c'
--- katze/katze-cellrenderercomboboxtext.c	2013-10-25 21:49:56 +0000
+++ katze/katze-cellrenderercomboboxtext.c	2014-05-20 02:22:37 +0000
@@ -334,7 +334,7 @@
  * value in the model, thus rendering a different string in each row
  * of the #GtkTreeView
  *
- * Return value: the new cell renderer
+ * Return value: (transfer full): the new cell renderer
  **/
 GtkCellRenderer *
 katze_cell_renderer_combobox_text_new (void)
 
=== modified file 'katze/katze-item.c'
--- katze/katze-item.c	2014-03-02 20:21:29 +0000
+++ katze/katze-item.c	2014-05-20 02:22:37 +0000
@@ -275,7 +275,7 @@
  *
  * Creates a new #KatzeItem.
  *
- * Return value: a new #KatzeItem
+ * Return value: (transfer full): a new #KatzeItem
  **/
 KatzeItem*
 katze_item_new (void)
@@ -825,7 +825,7 @@
  *
  * Since 0.4.3 meta data is copied.
  *
- * Return value: a new #KatzeItem
+ * Return value: (transfer full): a new #KatzeItem
  *
  * Since: 0.1.3
  **/
 
=== modified file 'katze/katze-preferences.c'
--- katze/katze-preferences.c	2014-03-14 19:03:51 +0000
+++ katze/katze-preferences.c	2014-05-20 02:22:37 +0000
@@ -103,7 +103,7 @@
  *
  * Creates a new preferences dialog.
  *
- * Return value: a new #KatzePreferences
+ * Return value: (transfer full): a new #KatzePreferences
  *
  * Since: 0.2.1
  **/
@@ -225,6 +225,9 @@
  *
  * Adds a new category with the specified label to the dialog.
  *
+ * Return value: (transfer none): a new #GtkBox in the preferences widget to
+ * hold the category's widgets
+ *
  * Since: 0.2.1
  *
  * Since 0.3.4 a #GtkBox is returned that can be packed into.
 
=== modified file 'katze/katze-utils.c'
--- katze/katze-utils.c	2014-02-23 14:51:05 +0000
+++ katze/katze-utils.c	2014-05-20 02:22:37 +0000
@@ -316,7 +316,7 @@
  * Since 0.2.1 the proxy may contain a label if the platform
  *     has according widgets.
  *
- * Return value: a new widget
+ * Return value: (transfer full): a new widget
  **/
 GtkWidget*
 katze_property_proxy (gpointer     object,
@@ -744,7 +744,7 @@
  * Creates an image menu item where the label is
  * reasonably ellipsized for you.
  *
- * Return value: a new label widget
+ * Return value: (transfer full): a new label widget
  **/
 GtkWidget*
 katze_image_menu_item_new_ellipsized (const gchar* label)
@@ -990,7 +990,7 @@
  *
  * Retrieve the object value of the specified property.
  *
- * Return value: an object
+ * Return value: (transfer none): an object
  **/
 gpointer
 katze_object_get_object (gpointer     object,
@@ -1092,7 +1092,7 @@
  * If @other_widget is given, it will become insensitive if
  * the input is not a valid URI.
  *
- * Returns: a #GtkEntry
+ * Returns: (transfer full): a #GtkEntry
  *
  * Since: 0.3.6
  */
 
=== modified file 'midori/midori-bookmarks-db.c'
--- midori/midori-bookmarks-db.c	2014-03-16 20:25:59 +0000
+++ midori/midori-bookmarks-db.c	2014-05-20 02:22:37 +0000
@@ -739,11 +739,11 @@
 
 /**
  * midori_bookmarks_db_import_array:
- * @array: the main bookmark array
+ * @bookmarks: the main bookmark array
  * @array: #KatzeArray containing the items to import
  * @parentid: the id of folder
  *
- * Imports the items of @array as childs of the folder
+ * Imports the items of @array as children of the folder
  * identfied by @parentid.
  *
  * Since: 0.5.2
 
=== modified file 'midori/midori-locationaction.c'
--- midori/midori-locationaction.c	2014-04-07 21:53:49 +0000
+++ midori/midori-locationaction.c	2014-05-20 02:22:37 +0000
@@ -1707,7 +1707,7 @@
 }
 
 /**
- * midori_location_action_set_security_hint:
+ * midori_location_action_set_secondary_icon:
  * @location_action: a #MidoriLocationAction
  * @icon: a stock ID, or an icon name
  *
@@ -1736,7 +1736,7 @@
 }
 
 /**
- * midori_location_action_primary_icon:
+ * midori_location_set_action_primary_icon:
  * @location_action: a #MidoriLocationAction
  * @icon: a list of icon names, preferred icon first
  * @tooltip: The tooltip to show
 
=== modified file 'midori/midori-view.c'
--- midori/midori-view.c	2014-04-28 22:01:42 +0000
+++ midori/midori-view.c	2014-05-20 02:22:37 +0000
@@ -3232,7 +3232,7 @@
 }
 
 /**
- * midori_view_new_with_item:
+ * midori_view_new_from_view:
  * @view: a predating, related #MidoriView, or %NULL
  * @item: a #KatzeItem, or %NULL
  * @settings: a #MidoriWebSettings, or %NULL