GNOME.org
 

[gtk+/gi-annotations: 12/13] Update GI annotations in 'Menus, Combo Box, Toolbar'

commit b46d98791d2b94e244c724da229882c5297bf46e
Author: Pavel Holejsovsky <pavel holejsovsky gmail com>
Date:   Tue Jan 11 17:25:48 2011 +0100

    Update GI annotations in 'Menus, Combo Box, Toolbar'
    
    'Menus, Combo Box' group from GTK+ manual, updated classes:
    GtkComboBox, GtkComboBoxText, GtkMenu, GtkMenuBar, GtkMenuItem,
    GtkImageMenuItem, GtkRadioMenuItem, GtkCheckMenuItem,
    GtkSeparatorMenuItem, GtkTearoffMenuItem, GtkToolShell, GtkToolbar,
    GtkToolItem, GtkToolPalette, GtkToolItemGroup, GtkSeparatorToolItem,
    GtkToolButton, GtkMenuToolButton, GtkToggleToolButton,
    GtkRadioToolButton.

 gtk/gtkcombobox.c        |    6 +++---
 gtk/gtkmenu.c            |   30 +++++++++++++++---------------
 gtk/gtkradiomenuitem.c   |   11 ++++++-----
 gtk/gtkradiotoolbutton.c |    2 +-
 gtk/gtktoolbar.c         |    3 +--
 gtk/gtktoolitem.c        |    2 +-
 gtk/gtktoolpalette.c     |    5 ++---
 gtk/gtktoolshell.c       |    2 +-
 8 files changed, 30 insertions(+), 31 deletions(-)
---
diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c
index b2adcfb..eab3bc4 100644
--- a/gtk/gtkcombobox.c
+++ b/gtk/gtkcombobox.c
@@ -4944,7 +4944,7 @@ gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box)
 }
 
 /**
- * gtk_combo_box_get_row_separator_func:
+ * gtk_combo_box_get_row_separator_func: (skip)
  * @combo_box: a #GtkComboBox
  *
  * Returns the current row separator function.
@@ -4965,8 +4965,8 @@ gtk_combo_box_get_row_separator_func (GtkComboBox *combo_box)
  * gtk_combo_box_set_row_separator_func:
  * @combo_box: a #GtkComboBox
  * @func: a #GtkTreeViewRowSeparatorFunc
- * @data: (allow-none): user data to pass to @func, or %NULL
- * @destroy: (allow-none): destroy notifier for @data, or %NULL
+ * @data: user data to pass to @func, or %NULL
+ * @destroy: destroy notifier for @data, or %NULL
  *
  * Sets the row separator function, which is used to determine
  * whether a row should be drawn as a separator. If the row separator
diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c
index 4f223de..4237b35 100644
--- a/gtk/gtkmenu.c
+++ b/gtk/gtkmenu.c
@@ -1184,10 +1184,10 @@ attach_widget_screen_changed (GtkWidget *attach_widget,
 }
 
 /**
- * gtk_menu_attach_to_widget:
+ * gtk_menu_attach_to_widget: (skip)
  * @menu: a #GtkMenu
  * @attach_widget: the #GtkWidget that the menu will be attached to
- * @detacher: the user supplied callback functions that will be called
+ * @detacher: the user supplied callback function that will be called
  *            when the menu calls gtk_menu_detach()
  *
  * Attaches the menu to the widget and provides a callback function
@@ -1251,7 +1251,7 @@ gtk_menu_attach_to_widget (GtkMenu           *menu,
  *
  * Returns the #GtkWidget that the menu is attached to.
  *
- * Returns: the #GtkWidget that the menu is attached to
+ * Returns: (transfer none): the #GtkWidget that the menu is attached to
  */
 GtkWidget*
 gtk_menu_get_attach_widget (GtkMenu *menu)
@@ -1337,9 +1337,9 @@ gtk_menu_remove (GtkContainer *container,
 /**
  * gtk_menu_new:
  *
- * Creates a new #GtkMenu.
+ * Creates a new #GtkMenu
  *
- * Returns: a new #GtkMenu.
+ * Returns: a new #GtkMenu
  */
 GtkWidget*
 gtk_menu_new (void)
@@ -1444,7 +1444,7 @@ popup_grab_on_window (GdkWindow *window,
 
 /**
  * gtk_menu_popup_for_device:
- * @menu: a #GtkMenu.
+ * @menu: a #GtkMenu
  * @device: (allow-none): a #GdkDevice
  * @parent_menu_shell: (allow-none): the menu shell containing the triggering
  *     menu item, or %NULL
@@ -1452,8 +1452,8 @@ popup_grab_on_window (GdkWindow *window,
  *     the popup, or %NULL
  * @func: (allow-none): a user supplied function used to position the menu,
  *     or %NULL
- * @data: (allow-none): user supplied data to be passed to @func
- * @destroy: (allow-none): destroy notify for @data
+ * @data: user supplied data to be passed to @func
+ * @destroy: destroy notify for @data
  * @button: the mouse button which was pressed to initiate the event
  * @activate_time: the time at which the activation event occurred
  *
@@ -1737,15 +1737,15 @@ gtk_menu_popup_for_device (GtkMenu             *menu,
 }
 
 /**
- * gtk_menu_popup:
- * @menu: a #GtkMenu.
+ * gtk_menu_popup: (skip)
+ * @menu: a #GtkMenu
  * @parent_menu_shell: (allow-none): the menu shell containing the
  *     triggering menu item, or %NULL
  * @parent_menu_item: (allow-none): the menu item whose activation
  *     triggered the popup, or %NULL
  * @func: (allow-none): a user supplied function used to position
  *     the menu, or %NULL
- * @data: (allow-none): user supplied data to be passed to @func.
+ * @data: user supplied data to be passed to @func.
  * @button: the mouse button which was pressed to initiate the event.
  * @activate_time: the time at which the activation event occurred.
  *
@@ -1889,9 +1889,9 @@ gtk_menu_popdown (GtkMenu *menu)
  * Returns the selected menu item from the menu.  This is used by the
  * #GtkOptionMenu.
  *
- * Returns: the #GtkMenuItem that was last selected in the menu.  If a
- *          selection has not yet been made, the first menu item is
- *          selected.
+ * Returns: (transfer none): the #GtkMenuItem that was last selected
+ *          in the menu.  If a selection has not yet been made, the
+ *          first menu item is selected.
  */
 GtkWidget*
 gtk_menu_get_active (GtkMenu *menu)
@@ -1995,7 +1995,7 @@ gtk_menu_set_accel_group (GtkMenu       *menu,
  * Gets the #GtkAccelGroup which holds global accelerators for the
  * menu.  See gtk_menu_set_accel_group().
  *
- * Returns: the #GtkAccelGroup associated with the menu.
+ * Returns: (transfer none): the #GtkAccelGroup associated with the menu.
  */
 GtkAccelGroup*
 gtk_menu_get_accel_group (GtkMenu *menu)
diff --git a/gtk/gtkradiomenuitem.c b/gtk/gtkradiomenuitem.c
index e875026..5ac7bf7 100644
--- a/gtk/gtkradiomenuitem.c
+++ b/gtk/gtkradiomenuitem.c
@@ -190,12 +190,12 @@ gtk_radio_menu_item_set_group (GtkRadioMenuItem *radio_menu_item,
 
 /**
  * gtk_radio_menu_item_new_with_label:
- * @group: (element-type GtkRadioMenuItem) (transfer full):
+ * @group: (element-type GtkRadioMenuItem):
  * @label: the text for the label
  *
  * Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel.
  *
- * Returns: (transfer none): A new #GtkRadioMenuItem
+ * Returns: A new #GtkRadioMenuItem
  */
 GtkWidget*
 gtk_radio_menu_item_new_with_label (GSList *group,
@@ -280,7 +280,7 @@ gtk_radio_menu_item_new_from_widget (GtkRadioMenuItem *group)
  *
  * The new #GtkRadioMenuItem is added to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
@@ -306,7 +306,7 @@ gtk_radio_menu_item_new_with_mnemonic_from_widget (GtkRadioMenuItem *group,
  * Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
  * The new #GtkRadioMenuItem is added to the same group as @group.
  *
- * Return value: (transfer full): The new #GtkRadioMenuItem
+ * Return value: (transfer none): The new #GtkRadioMenuItem
  *
  * Since: 2.4
  **/
@@ -331,7 +331,8 @@ gtk_radio_menu_item_new_with_label_from_widget (GtkRadioMenuItem *group,
  * Returns the group to which the radio menu item belongs, as a #GList of
  * #GtkRadioMenuItem. The list belongs to GTK+ and should not be freed.
  *
- * Returns: (transfer none): the group of @radio_menu_item
+ * Returns: (element-type GtkRadioMenuItem) (transfer none): the group
+ *     of @radio_menu_item
  */
 GSList*
 gtk_radio_menu_item_get_group (GtkRadioMenuItem *radio_menu_item)
diff --git a/gtk/gtkradiotoolbutton.c b/gtk/gtkradiotoolbutton.c
index 9a37c18..52d78cd 100644
--- a/gtk/gtkradiotoolbutton.c
+++ b/gtk/gtkradiotoolbutton.c
@@ -167,7 +167,7 @@ gtk_radio_tool_button_new_from_stock (GSList      *group,
  *
  * Creates a new #GtkRadioToolButton adding it to the same group as @gruup
  *
- * Return value: (transfer full): The new #GtkRadioToolButton
+ * Return value: (transfer none): The new #GtkRadioToolButton
  *
  * Since: 2.4
  **/
diff --git a/gtk/gtktoolbar.c b/gtk/gtktoolbar.c
index e222e08..db60eea 100644
--- a/gtk/gtktoolbar.c
+++ b/gtk/gtktoolbar.c
@@ -3008,8 +3008,7 @@ gtk_toolbar_get_nth_item (GtkToolbar *toolbar,
  *
  * Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size().
  *
- * Return value: (type int): the current icon size for the icons on
- * the toolbar.
+ * Return value: the current icon size for the icons on the toolbar.
  **/
 GtkIconSize
 gtk_toolbar_get_icon_size (GtkToolbar *toolbar)
diff --git a/gtk/gtktoolitem.c b/gtk/gtktoolitem.c
index b296e3b..e91b8ca 100644
--- a/gtk/gtktoolitem.c
+++ b/gtk/gtktoolitem.c
@@ -725,7 +725,7 @@ gtk_tool_item_get_ellipsize_mode (GtkToolItem *tool_item)
  * #GtkToolItem should call this function to find out what size icons
  * they should use.
  * 
- * Return value: (type int): a #GtkIconSize indicating the icon size
+ * Return value: a #GtkIconSize indicating the icon size
  * used for @tool_item
  * 
  * Since: 2.4
diff --git a/gtk/gtktoolpalette.c b/gtk/gtktoolpalette.c
index e35bf81..6782af6 100644
--- a/gtk/gtktoolpalette.c
+++ b/gtk/gtktoolpalette.c
@@ -1119,8 +1119,7 @@ gtk_tool_palette_new (void)
 /**
  * gtk_tool_palette_set_icon_size:
  * @palette: a #GtkToolPalette
- * @icon_size: (type int): the #GtkIconSize that icons in the tool
- *     palette shall have
+ * @icon_size: the #GtkIconSize that icons in the tool palette shall have
  *
  * Sets the size of icons in the tool palette.
  *
@@ -1286,7 +1285,7 @@ gtk_tool_palette_unset_style (GtkToolPalette *palette)
  * Gets the size of icons in the tool palette.
  * See gtk_tool_palette_set_icon_size().
  *
- * Returns: (type int): the #GtkIconSize of icons in the tool palette
+ * Returns: the #GtkIconSize of icons in the tool palette
  *
  * Since: 2.20
  */
diff --git a/gtk/gtktoolshell.c b/gtk/gtktoolshell.c
index 7dc4bf5..82c6d87 100644
--- a/gtk/gtktoolshell.c
+++ b/gtk/gtktoolshell.c
@@ -61,7 +61,7 @@ gtk_tool_shell_default_init (GtkToolShellInterface *iface)
  * Retrieves the icon size for the tool shell. Tool items must not call this
  * function directly, but rely on gtk_tool_item_get_icon_size() instead.
  *
- * Return value: (type int): the current size for icons of @shell
+ * Return value: the current size for icons of @shell
  *
  * Since: 2.14
  **/
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]