[gtk+/gi-annotations: 18/30] Update GI annotations in 'Action-based menus and toolbars'
- From: Pavel Holejsovsky <pholejs src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/gi-annotations: 18/30] Update GI annotations in 'Action-based menus and toolbars'
- Date: Sun, 16 Jan 2011 08:39:56 +0000 (UTC)
commit 9d374c314cfd16686dfafc5f5b0c2807d2572523
Author: Pavel Holejsovsky <pholejs src gnome org>
Date: Wed Jan 12 16:49:37 2011 +0100
Update GI annotations in 'Action-based menus and toolbars'
'Action-based menus and toolbars' group from GTK+ manual is:
GtkUIManager, GtkActionGroup, GtkAction, GtkToggleAction,
GtkRadioAction, GtkRecentAction, GtkActivatable.
gtk/gtkaction.c | 21 ++++++++++++---------
gtk/gtkactiongroup.c | 24 ++++++++++++------------
gtk/gtkradioaction.c | 7 ++++---
gtk/gtkrecentaction.c | 14 ++++++++------
gtk/gtktoggleaction.c | 7 ++++---
gtk/gtkuimanager.c | 2 +-
6 files changed, 41 insertions(+), 34 deletions(-)
---
diff --git a/gtk/gtkaction.c b/gtk/gtkaction.c
index 64b94bf..45a93a0 100644
--- a/gtk/gtkaction.c
+++ b/gtk/gtkaction.c
@@ -506,10 +506,11 @@ gtk_action_buildable_get_name (GtkBuildable *buildable)
/**
* gtk_action_new:
* @name: A unique name for the action
- * @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
+ * @label: (allow-none): the label displayed in menu items and on buttons,
+ * or %NULL
* @tooltip: (allow-none): a tooltip for the action, or %NULL
- * @stock_id: the stock icon to display in widgets representing the
- * action, or %NULL
+ * @stock_id: (allow-none): the stock icon to display in widgets representing
+ * the action, or %NULL
*
* Creates a new #GtkAction object. To add the action to a
* #GtkActionGroup and set the accelerator for the action,
@@ -873,7 +874,7 @@ gtk_action_unblock_activate (GtkAction *action)
* This function is intended for use by action implementations to
* create icons displayed in the proxy widgets.
*
- * Returns: (transfer full): a widget that displays the icon for this action.
+ * Returns: (transfer none): a widget that displays the icon for this action.
*
* Since: 2.4
*/
@@ -899,7 +900,7 @@ gtk_action_create_icon (GtkAction *action, GtkIconSize icon_size)
*
* Creates a menu item widget that proxies for the given action.
*
- * Returns: (transfer full): a menu item connected to the action.
+ * Returns: (transfer none): a menu item connected to the action.
*
* Since: 2.4
*/
@@ -924,7 +925,7 @@ gtk_action_create_menu_item (GtkAction *action)
*
* Creates a toolbar item widget that proxies for the given action.
*
- * Returns: (transfer full): a toolbar item connected to the action.
+ * Returns: (transfer none): a toolbar item connected to the action.
*
* Since: 2.4
*/
@@ -1705,8 +1706,9 @@ gtk_action_get_accel_path (GtkAction *action)
*
* Since: 2.8
*
- * Returns: the accel closure for this action. The returned closure is
- * owned by GTK+ and must not be unreffed or modified.
+ * Returns: (transfer none): the accel closure for this action. The
+ * returned closure is owned by GTK+ and must not be unreffed
+ * or modified.
*/
GClosure *
gtk_action_get_accel_closure (GtkAction *action)
@@ -1811,7 +1813,8 @@ gtk_action_disconnect_accelerator (GtkAction *action)
* item or the toolbar item it creates, this function returns an
* instance of that menu.
*
- * Return value: (transfer full): the menu item provided by the action, or %NULL.
+ * Return value: (transfer none): the menu item provided by the
+ * action, or %NULL.
*
* Since: 2.12
*/
diff --git a/gtk/gtkactiongroup.c b/gtk/gtkactiongroup.c
index d0749f4..a3d1f5b 100644
--- a/gtk/gtkactiongroup.c
+++ b/gtk/gtkactiongroup.c
@@ -1003,9 +1003,9 @@ gtk_action_group_list_actions (GtkActionGroup *action_group)
/**
- * gtk_action_group_add_actions:
+ * gtk_action_group_add_actions: (skip)
* @action_group: the action group
- * @entries: an array of action descriptions
+ * @entries: (array length=n_entries): an array of action descriptions
* @n_entries: the number of entries
* @user_data: data to pass to the action callbacks
*
@@ -1054,9 +1054,9 @@ shared_data_unref (gpointer data)
/**
- * gtk_action_group_add_actions_full:
+ * gtk_action_group_add_actions_full: (skip)
* @action_group: the action group
- * @entries: an array of action descriptions
+ * @entries: (array length=n_entries): an array of action descriptions
* @n_entries: the number of entries
* @user_data: data to pass to the action callbacks
* @destroy: destroy notification callback for @user_data
@@ -1134,9 +1134,9 @@ gtk_action_group_add_actions_full (GtkActionGroup *action_group,
}
/**
- * gtk_action_group_add_toggle_actions:
+ * gtk_action_group_add_toggle_actions: (skip)
* @action_group: the action group
- * @entries: an array of toggle action descriptions
+ * @entries: (array length=n_entries): an array of toggle action descriptions
* @n_entries: the number of entries
* @user_data: data to pass to the action callbacks
*
@@ -1162,9 +1162,9 @@ gtk_action_group_add_toggle_actions (GtkActionGroup *action_group,
/**
- * gtk_action_group_add_toggle_actions_full:
+ * gtk_action_group_add_toggle_actions_full: (skip)
* @action_group: the action group
- * @entries: an array of toggle action descriptions
+ * @entries: (array length=n_entries): an array of toggle action descriptions
* @n_entries: the number of entries
* @user_data: data to pass to the action callbacks
* @destroy: destroy notification callback for @user_data
@@ -1243,9 +1243,9 @@ gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_gro
}
/**
- * gtk_action_group_add_radio_actions:
+ * gtk_action_group_add_radio_actions: (skip)
* @action_group: the action group
- * @entries: an array of radio action descriptions
+ * @entries: (array length=n_entries): an array of radio action descriptions
* @n_entries: the number of entries
* @value: the value of the action to activate initially, or -1 if
* no action should be activated
@@ -1276,9 +1276,9 @@ gtk_action_group_add_radio_actions (GtkActionGroup *action_group,
}
/**
- * gtk_action_group_add_radio_actions_full:
+ * gtk_action_group_add_radio_actions_full: (skip)
* @action_group: the action group
- * @entries: an array of radio action descriptions
+ * @entries: (array length=n_entries): an array of radio action descriptions
* @n_entries: the number of entries
* @value: the value of the action to activate initially, or -1 if
* no action should be activated
diff --git a/gtk/gtkradioaction.c b/gtk/gtkradioaction.c
index 47cb3f4..e225825 100644
--- a/gtk/gtkradioaction.c
+++ b/gtk/gtkradioaction.c
@@ -193,10 +193,11 @@ gtk_radio_action_init (GtkRadioAction *action)
/**
* gtk_radio_action_new:
* @name: A unique name for the action
- * @label: (allow-none): The label displayed in menu items and on buttons, or %NULL
+ * @label: (allow-none): The label displayed in menu items and on buttons,
+ * or %NULL
* @tooltip: (allow-none): A tooltip for this action, or %NULL
- * @stock_id: The stock icon to display in widgets representing this
- * action, or %NULL
+ * @stock_id: (allow-none): The stock icon to display in widgets representing
+ * this action, or %NULL
* @value: The value which gtk_radio_action_get_current_value() should
* return if this action is selected.
*
diff --git a/gtk/gtkrecentaction.c b/gtk/gtkrecentaction.c
index 5d73594..0866eed 100644
--- a/gtk/gtkrecentaction.c
+++ b/gtk/gtkrecentaction.c
@@ -670,10 +670,11 @@ gtk_recent_action_init (GtkRecentAction *action)
/**
* gtk_recent_action_new:
* @name: a unique name for the action
- * @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
+ * @label: (allow-none): the label displayed in menu items and on buttons,
+ * or %NULL
* @tooltip: (allow-none): a tooltip for the action, or %NULL
- * @stock_id: the stock icon to display in widgets representing the
- * action, or %NULL
+ * @stock_id: (allow-none): the stock icon to display in widgets representing
+ the action, or %NULL
*
* Creates a new #GtkRecentAction object. To add the action to
* a #GtkActionGroup and set the accelerator for the action,
@@ -702,10 +703,11 @@ gtk_recent_action_new (const gchar *name,
/**
* gtk_recent_action_new_for_manager:
* @name: a unique name for the action
- * @label: (allow-none): the label displayed in menu items and on buttons, or %NULL
+ * @label: (allow-none): the label displayed in menu items and on buttons,
+ * or %NULL
* @tooltip: (allow-none): a tooltip for the action, or %NULL
- * @stock_id: the stock icon to display in widgets representing the
- * action, or %NULL
+ * @stock_id: (allow-none): the stock icon to display in widgets representing
+ * the action, or %NULL
* @manager: (allow-none): a #GtkRecentManager, or %NULL for using the default
* #GtkRecentManager
*
diff --git a/gtk/gtktoggleaction.c b/gtk/gtktoggleaction.c
index 525d462..c36a924 100644
--- a/gtk/gtktoggleaction.c
+++ b/gtk/gtktoggleaction.c
@@ -166,10 +166,11 @@ gtk_toggle_action_init (GtkToggleAction *action)
/**
* gtk_toggle_action_new:
* @name: A unique name for the action
- * @label: (allow-none): The label displayed in menu items and on buttons, or %NULL
+ * @label: (allow-none): The label displayed in menu items and on buttons,
+ * or %NULL
* @tooltip: (allow-none): A tooltip for the action, or %NULL
- * @stock_id: The stock icon to display in widgets representing the
- * action, or %NULL
+ * @stock_id: (allow-none): The stock icon to display in widgets representing
+ * the action, or %NULL
*
* Creates a new #GtkToggleAction object. To add the action to
* a #GtkActionGroup and set the accelerator for the action,
diff --git a/gtk/gtkuimanager.c b/gtk/gtkuimanager.c
index 7162f77..e5e536a 100644
--- a/gtk/gtkuimanager.c
+++ b/gtk/gtkuimanager.c
@@ -1700,7 +1700,7 @@ gtk_ui_manager_add_ui_from_string (GtkUIManager *manager,
/**
* gtk_ui_manager_add_ui_from_file:
* @manager: a #GtkUIManager object
- * @filename: the name of the file to parse
+ * @filename: (type filename): the name of the file to parse
* @error: return location for an error
*
* Parses a file containing a <link linkend="XML-UI">UI definition</link> and
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]