Commit 6529c076 authored by Colin Walters's avatar Colin Walters Committed by Johan Dahlin

[introspection] Merge in Gtk-custom.c annotations

The Gtk-custom.c file in gir-repository contained a number of
introspection annotations.  Merge those into the GTK source files.

Some documentation was moved from the tmpl/ files to accomodate
the addition of annotations.
parent b3c48a45
......@@ -264,12 +264,6 @@ directions for the visible progress bar.
<!-- ##### FUNCTION gtk_progress_bar_new_with_adjustment ##### -->
<para>
Creates a new #GtkProgressBar with an associated #GtkAdjustment.
</para>
@adjustment: a #GtkAdjustment.
@Returns: a #GtkProgressBar.
<!-- ##### FUNCTION gtk_progress_bar_set_bar_style ##### -->
......
......@@ -197,13 +197,6 @@ gtk_radio_button_get_group().
<!-- ##### FUNCTION gtk_radio_button_get_group ##### -->
<para>
Retrieves the group assigned to a radio button.
</para>
@radio_button: a #GtkRadioButton.
@Returns: a linked list containing all the radio buttons in the same group
as @radio_button. The returned list is owned by the radio button
and must not be modified or freed.
......@@ -80,14 +80,6 @@ Creates a new #GtkRadioMenuItem.
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_label ##### -->
<para>
Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel.
</para>
@group: the group to which the radio menu item is to be attached
@label: the text for the label
@Returns: a new #GtkRadioMenuItem
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_mnemonic ##### -->
<para>
......
......@@ -246,13 +246,12 @@ GTK_SPIN_END</entry>
<!-- ##### FUNCTION gtk_spin_button_configure ##### -->
<para>
Changes the properties of an existing spin button. The adjustment, climb rate, and number of decimal places are all changed accordingly, after this function call.
</para>
@spin_button: a #GtkSpinButton.
@adjustment: a #GtkAdjustment.
@climb_rate: the new climb rate.
@digits: the number of decimal places to display in the spin button.
@adjustment:
<!-- ##### FUNCTION gtk_spin_button_new ##### -->
......
......@@ -136,15 +136,6 @@ Returns whether the style is attached to a window.
</para>
@style:
@window:
@set_bg:
@state_type:
@area:
@x:
@y:
@width:
@height:
<!-- ##### MACRO gtk_style_apply_default_pixmap ##### -->
......
......@@ -146,16 +146,6 @@ Sets the time between the user moving the mouse over a widget and the widget's t
<!-- ##### FUNCTION gtk_tooltips_set_tip ##### -->
<para>
Adds a tooltip containing the message @tip_text to the specified #GtkWidget.
</para>
@tooltips: a #GtkTooltips.
@widget: the #GtkWidget you wish to associate the tip with.
@tip_text: a string containing the tip itself.
@tip_private: a string of any further information that may be useful if the user gets stuck.
@Deprecated: 2.12:
<!-- ##### FUNCTION gtk_tooltips_data_get ##### -->
<para>
......
......@@ -933,7 +933,7 @@ update_name_version (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_name:
* @about: a #GtkAboutDialog
* @name: the program name
* @name: (allow-none): the program name
*
* Sets the name to display in the about dialog.
* If this is not set, it defaults to g_get_application_name().
......@@ -1005,7 +1005,7 @@ gtk_about_dialog_get_version (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_version:
* @about: a #GtkAboutDialog
* @version: the version string
* @version: (allow-none): the version string
*
* Sets the version string to display in the about dialog.
*
......@@ -1057,7 +1057,7 @@ gtk_about_dialog_get_copyright (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_copyright:
* @about: a #GtkAboutDialog
* @copyright: the copyright string
* @copyright: (allow-none) the copyright string
*
* Sets the copyright string to display in the about dialog.
* This should be a short string of one or two lines.
......@@ -1120,7 +1120,7 @@ gtk_about_dialog_get_comments (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_comments:
* @about: a #GtkAboutDialog
* @comments: a comments string
* @comments: (allow-none): a comments string
*
* Sets the comments string to display in the about dialog.
* This should be a short string of one or two lines.
......@@ -1181,7 +1181,7 @@ gtk_about_dialog_get_license (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_license:
* @about: a #GtkAboutDialog
* @license: the license information or %NULL
* @license: (allow-none): the license information or %NULL
*
* Sets the license information to be displayed in the secondary
* license dialog. If @license is %NULL, the license button is
......@@ -1295,7 +1295,7 @@ gtk_about_dialog_get_website (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_website:
* @about: a #GtkAboutDialog
* @website: a URL string starting with "http://"
* @website: (allow-none): a URL string starting with "http://"
*
* Sets the URL to use for the website link.
*
......@@ -1587,7 +1587,7 @@ gtk_about_dialog_get_translator_credits (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_translator_credits:
* @about: a #GtkAboutDialog
* @translator_credits: the translator credits
* @translator_credits: (allow-none): the translator credits
*
* Sets the translator credits string which is displayed in
* the translators tab of the secondary credits dialog.
......@@ -1674,7 +1674,7 @@ icon_set_new_from_pixbufs (GList *pixbufs)
/**
* gtk_about_dialog_set_logo:
* @about: a #GtkAboutDialog
* @logo: a #GdkPixbuf, or %NULL
* @logo: (allow-none): a #GdkPixbuf, or %NULL
*
* Sets the pixbuf to be displayed as logo in the about dialog.
* If it is %NULL, the default window icon set with
......@@ -1751,7 +1751,7 @@ gtk_about_dialog_get_logo_icon_name (GtkAboutDialog *about)
/**
* gtk_about_dialog_set_logo_icon_name:
* @about: a #GtkAboutDialog
* @icon_name: an icon name, or %NULL
* @icon_name: (allow-none): an icon name, or %NULL
*
* Sets the pixbuf to be displayed as logo in the about dialog.
* If it is %NULL, the default window icon set with
......
......@@ -352,9 +352,10 @@ _gtk_accel_group_detach (GtkAccelGroup *accel_group,
/**
* gtk_accel_groups_from_object:
* @object: a #GObject, usually a #GtkWindow
* @returns: a list of all accel groups which are attached to @object
*
* Gets a list of all accel groups which are attached to @object.
*
* Returns: (element-type GtkAccelGroup) (transfer none): a list of all accel groups which are attached to @object
*/
GSList*
gtk_accel_groups_from_object (GObject *object)
......
......@@ -979,7 +979,7 @@ gtk_action_disconnect_proxy (GtkAction *action,
* Returns the proxy widgets for an action.
* See also gtk_widget_get_action().
*
* Return value: a #GSList of proxy widgets. The list is owned by GTK+
* Return value: (element-type GtkWidget) (transfer none): a #GSList of proxy widgets. The list is owned by GTK+
* and must not be modified.
*
* Since: 2.4
......@@ -1811,7 +1811,7 @@ gtk_action_get_accel_closure (GtkAction *action)
/**
* gtk_action_set_accel_group:
* @action: the action object
* @accel_group: a #GtkAccelGroup or %NULL
* @accel_group: (allow-none): a #GtkAccelGroup or %NULL
*
* Sets the #GtkAccelGroup in which the accelerator for this action
* will be installed.
......
......@@ -731,7 +731,7 @@ gtk_action_group_set_visible (GtkActionGroup *action_group,
*
* Looks up an action in the action group by name.
*
* Returns: the action, or %NULL if no action by that name exists
* Returns: (transfer-none): the action, or %NULL if no action by that name exists
*
* Since: 2.4
*/
......@@ -807,7 +807,7 @@ gtk_action_group_add_action (GtkActionGroup *action_group,
* gtk_action_group_add_action_with_accel:
* @action_group: the action group
* @action: the action to add
* @accelerator: the accelerator for the action, in
* @accelerator: (allow-none): the accelerator for the action, in
* the format understood by gtk_accelerator_parse(), or "" for no accelerator, or
* %NULL to use the stock accelerator
*
......@@ -920,7 +920,7 @@ add_single_action (gpointer key,
*
* Lists the actions in the action group.
*
* Returns: an allocated list of the action objects in the action group
* Returns: (element-type GtkAction) (transfer container): an allocated list of the action objects in the action group
*
* Since: 2.4
*/
......
......@@ -1980,7 +1980,7 @@ gtk_assistant_get_page_type (GtkAssistant *assistant,
* gtk_assistant_set_page_header_image:
* @assistant: a #GtkAssistant
* @page: a page of @assistant
* @pixbuf: the new header image @page
* @pixbuf: (allow-none): the new header image @page
*
* Sets a header image for @page. This image is displayed in the header
* area of the assistant when @page is the current page.
......@@ -2060,7 +2060,7 @@ gtk_assistant_get_page_header_image (GtkAssistant *assistant,
* gtk_assistant_set_page_side_image:
* @assistant: a #GtkAssistant
* @page: a page of @assistant
* @pixbuf: the new header image @page
* @pixbuf: (allow-none): the new header image @page
*
* Sets a header image for @page. This image is displayed in the side
* area of the assistant when @page is the current page.
......
......@@ -136,7 +136,7 @@ gtk_bin_forall (GtkContainer *container,
* no child widget. The returned widget does not have a reference
* added, so you do not need to unref it.
*
* Return value: pointer to child of the #GtkBin
* Return value: (transfer none): pointer to child of the #GtkBin
**/
GtkWidget*
gtk_bin_get_child (GtkBin *bin)
......
......@@ -888,7 +888,7 @@ object_add_to_list (gchar *object_id,
* this function does not increment the reference counts of the returned
* objects.
*
* Return value: a newly-allocated #GSList containing all the objects
* Return value: (element-type GObject) (transfer container): a newly-allocated #GSList containing all the objects
* constructed by the #GtkBuilder instance. It should be freed by
* g_slist_free()
*
......
......@@ -292,7 +292,7 @@ gtk_cell_layout_reorder (GtkCellLayout *cell_layout,
*
* Returns the cell renderers which have been added to @cell_layout.
*
* Return value: a list of cell renderers. The list, but not the
* Return value: (element-type GtkCellRenderer) (transfer container): a list of cell renderers. The list, but not the
* renderers has been newly allocated and should be freed with
* g_list_free() when no longer needed.
*
......
......@@ -857,7 +857,7 @@ gtk_cell_view_set_value (GtkCellView *cell_view,
/**
* gtk_cell_view_set_model:
* @cell_view: a #GtkCellView
* @model: a #GtkTreeModel
* @model: (allow-none): a #GtkTreeModel
*
* Sets the model for @cell_view. If @cell_view already has a model
* set, it will remove it before setting the new model. If @model is
......@@ -910,7 +910,7 @@ gtk_cell_view_get_model (GtkCellView *cell_view)
/**
* gtk_cell_view_set_displayed_row:
* @cell_view: a #GtkCellView
* @path: a #GtkTreePath or %NULL to unset.
* @path: (allow-none): a #GtkTreePath or %NULL to unset.
*
* Sets the row of the model that is currently displayed
* by the #GtkCellView. If the path is unset, then the
......
......@@ -1527,7 +1527,8 @@ clipboard_uris_received_func (GtkClipboard *clipboard,
* for the data to be received using the main loop, so events,
* timeouts, etc, may be dispatched during the wait.
*
* Return value: a newly-allocated %NULL-terminated array of strings which must
* Return value: (array zero-terminated=1) (element-type utf8) (transfer full): a newly-allocated
* %NULL-terminated array of strings which must
* be freed with g_strfreev(), or %NULL if
* retrieving the selection data failed. (This
* could happen for various reasons, in particular
......
......@@ -2274,6 +2274,10 @@ gtk_clist_get_text (GtkCList *clist,
return 1;
}
/**
* gtk_clist_set_pixmap:
* @mask: (allow-none):
*/
void
gtk_clist_set_pixmap (GtkCList *clist,
gint row,
......
......@@ -5020,7 +5020,7 @@ gtk_combo_box_set_active_iter (GtkComboBox *combo_box,
/**
* gtk_combo_box_set_model:
* @combo_box: A #GtkComboBox
* @model: A #GtkTreeModel
* @model: (allow-none): A #GtkTreeModel
*
* Sets the model used by @combo_box to be @model. Will unset a previously set
* model (if applicable). If model is %NULL, then it will unset the model.
......@@ -5104,7 +5104,7 @@ out:
*
* Returns the #GtkTreeModel which is acting as data source for @combo_box.
*
* Return value: A #GtkTreeModel which was passed during construction.
* Return value: (transfer none): A #GtkTreeModel which was passed during construction.
*
* Since: 2.4
*/
......@@ -5129,7 +5129,7 @@ gtk_combo_box_get_model (GtkComboBox *combo_box)
* gtk_combo_box_insert_text(), gtk_combo_box_prepend_text() and
* gtk_combo_box_remove_text().
*
* Return value: A new text combo box.
* Return value: (transfer none): A new text combo box.
*
* Since: 2.4
*/
......
......@@ -1586,7 +1586,7 @@ gtk_container_foreach_full (GtkContainer *container,
/**
* gtk_container_set_focus_child:
* @container: a #GtkContainer
* @child: a #GtkWidget, or %NULL
* @child: (allow-none): a #GtkWidget, or %NULL
*
* Sets, or unsets if @child is %NULL, the focused child of @container.
*
......@@ -1631,7 +1631,7 @@ gtk_container_get_focus_child (GtkContainer *container)
* Returns the container's non-internal children. See
* gtk_container_forall() for details on what constitutes an "internal" child.
*
* Return value: a newly-allocated list of the container's non-internal children.
* Return value: (element-type GtkWidget) (transfer container): a newly-allocated list of the container's non-internal children.
**/
GList*
gtk_container_get_children (GtkContainer *container)
......@@ -2403,7 +2403,8 @@ gtk_container_set_focus_chain (GtkContainer *container,
/**
* gtk_container_get_focus_chain:
* @container: a #GtkContainer
* @focusable_widgets: location to store the focus chain of the
* @focusable_widgets: (element-type GtkWidget) (out) (transfer container): location
* to store the focus chain of the
* container, or %NULL. You should free this list
* using g_list_free() when you are done with it, however
* no additional reference count is added to the
......@@ -2513,7 +2514,7 @@ gtk_container_set_focus_vadjustment (GtkContainer *container,
* Retrieves the vertical focus adjustment for the container. See
* gtk_container_set_focus_vadjustment().
*
* Return value: the vertical focus adjustment, or %NULL if
* Return value: (transfer none): the vertical focus adjustment, or %NULL if
* none has been set.
**/
GtkAdjustment *
......@@ -2568,7 +2569,7 @@ gtk_container_set_focus_hadjustment (GtkContainer *container,
* Retrieves the horizontal focus adjustment for the container. See
* gtk_container_set_focus_hadjustment ().
*
* Return value: the horizontal focus adjustment, or %NULL if
* Return value: (transfer none): the horizontal focus adjustment, or %NULL if
* none has been set.
**/
GtkAdjustment *
......
......@@ -3626,6 +3626,14 @@ real_insert_row (GtkCList *clist,
return row;
}
/**
* gtk_ctree_insert_node:
* @pixmap_closed: (allow-none):
* @mask_closed: (allow-none):
* @pixmap_opened: (allow-none):
* @mask_opened: (allow-none):
*/
GtkCTreeNode *
gtk_ctree_insert_node (GtkCTree *ctree,
GtkCTreeNode *parent,
......@@ -4286,6 +4294,11 @@ gtk_ctree_is_hot_spot (GtkCTree *ctree,
***********************************************************/
/**
* gtk_ctree_move:
* @new_parent: (allow-none):
* @new_sibling: (allow-none):
*/
void
gtk_ctree_move (GtkCTree *ctree,
GtkCTreeNode *node,
......@@ -4599,6 +4612,11 @@ gtk_ctree_node_set_text (GtkCTree *ctree,
tree_draw_node (ctree, node);
}
/**
* gtk_ctree_node_set_pixmap:
* @mask: (allow-none):
*/
void
gtk_ctree_node_set_pixmap (GtkCTree *ctree,
GtkCTreeNode *node,
......@@ -4628,6 +4646,11 @@ gtk_ctree_node_set_pixmap (GtkCTree *ctree,
tree_draw_node (ctree, node);
}
/**
* gtk_ctree_node_set_pixtext:
* @mask: (allow-none):
*/
void
gtk_ctree_node_set_pixtext (GtkCTree *ctree,
GtkCTreeNode *node,
......@@ -4662,6 +4685,14 @@ gtk_ctree_node_set_pixtext (GtkCTree *ctree,
tree_draw_node (ctree, node);
}
/**
* gtk_ctree_set_node_info:
* @pixmap_closed: (allow-none):
* @mask_closed: (allow-none):
* @pixmap_opened: (allow-none):
* @mask_opened: (allow-none):
*/
void
gtk_ctree_set_node_info (GtkCTree *ctree,
GtkCTreeNode *node,
......
......@@ -529,10 +529,10 @@ gtk_dialog_new_empty (const gchar *title,
/**
* gtk_dialog_new_with_buttons:
* @title: Title of the dialog, or %NULL
* @parent: Transient parent of the dialog, or %NULL
* @title: (allow-none): Title of the dialog, or %NULL
* @parent: (allow-none): Transient parent of the dialog, or %NULL
* @flags: from #GtkDialogFlags
* @first_button_text: stock ID or text to go in first button, or %NULL
* @first_button_text: (allow-none): stock ID or text to go in first button, or %NULL
* @Varargs: response ID for first button, then additional buttons, ending with %NULL
*
* Creates a new #GtkDialog with title @title (or %NULL for the default
......@@ -1191,7 +1191,7 @@ gtk_dialog_get_response_for_widget (GtkDialog *dialog,
/**
* gtk_alternative_dialog_button_order:
* @screen: a #GdkScreen, or %NULL to use the default screen
* @screen: (allow-none): a #GdkScreen, or %NULL to use the default screen
*
* Returns %TRUE if dialogs are expected to use an alternative
* button order on the screen @screen. See
......@@ -1519,7 +1519,7 @@ gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
*
* Returns the action area of @dialog.
*
* Returns: the action area.
* Returns: (transfer none): the action area.
*
* Since: 2.14
**/
......@@ -1537,7 +1537,7 @@ gtk_dialog_get_action_area (GtkDialog *dialog)
*
* Returns the content area of @dialog.
*
* Returns: the content area #GtkVBox.
* Returns: (transfer none): the content area #GtkVBox.
*
* Since: 2.14
**/
......
......@@ -2831,7 +2831,7 @@ gtk_drag_source_unset_icon (GtkDragSourceSite *site)
* @widget: a #GtkWidget
* @colormap: the colormap of the icon
* @pixmap: the image data for the icon
* @mask: the transparency mask for an image.
* @mask: (allow-none): the transparency mask for an image.
*
* Sets the icon that will be used for drags from a particular widget
* from a pixmap/mask. GTK+ retains references for the arguments, and
......
......@@ -149,7 +149,7 @@ gtk_editable_base_init (gpointer g_class)
* @editable: a #GtkEditable
* @new_text: the text to append
* @new_text_length: the length of the text in bytes, or -1
* @position: location of the position text will be inserted at
* @position: (in-out): location of the position text will be inserted at
*
* Inserts @new_text_length bytes of @new_text into the contents of the
* widget, at position @position.
......@@ -266,8 +266,8 @@ gtk_editable_get_position (GtkEditable *editable)
/**
* gtk_editable_get_selection_bounds:
* @editable: a #GtkEditable
* @start_pos: location to store the starting position, or %NULL
* @end_pos: location to store the end position, or %NULL
* @start_pos: (out) (allow-none): location to store the starting position, or %NULL
* @end_pos: (out) (allow-none): location to store the end position, or %NULL
*
* Retrieves the selection bound of the editable. start_pos will be filled
* with the start of the selection and @end_pos with end. If no text was
......
......@@ -7238,7 +7238,7 @@ gtk_entry_get_has_frame (GtkEntry *entry)
/**
* gtk_entry_set_inner_border:
* @entry: a #GtkEntry
* @border: a #GtkBorder, or %NULL
* @border: (allow-none): a #GtkBorder, or %NULL
*
* Sets %entry's inner-border property to %border, or clears it if %NULL
* is passed. The inner-border is the area around the entry's text, but
......@@ -7276,7 +7276,7 @@ gtk_entry_set_inner_border (GtkEntry *entry,
* This function returns the entry's #GtkEntry:inner-border property. See
* gtk_entry_set_inner_border() for more information.
*
* Return value: the entry's #GtkBorder, or %NULL if none was set.
* Return value: (transfer none): the entry's #GtkBorder, or %NULL if none was set.
*
* Since: 2.10
**/
......@@ -7303,7 +7303,7 @@ gtk_entry_get_inner_border (GtkEntry *entry)
* gtk_entry_text_index_to_layout_index() are needed to convert byte
* indices in the layout to byte indices in the entry contents.
*
* Return value: the #PangoLayout for this entry
* Return value: (transfer none): the #PangoLayout for this entry
**/
PangoLayout*
gtk_entry_get_layout (GtkEntry *entry)
......@@ -9626,7 +9626,7 @@ connect_completion_signals (GtkEntry *entry,
/**
* gtk_entry_set_completion:
* @entry: A #GtkEntry
* @completion: The #GtkEntryCompletion or %NULL
* @completion: (allow-none): The #GtkEntryCompletion or %NULL
*
* Sets @completion to be the auxiliary completion object to use with @entry.
* All further configuration of the completion mechanism is done on
......@@ -9743,7 +9743,7 @@ gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
* Retrieves the horizontal cursor adjustment for the entry.
* See gtk_entry_set_cursor_hadjustment().
*
* Return value: the horizontal cursor adjustment, or %NULL
* Return value: (transfer none): the horizontal cursor adjustment, or %NULL
* if none has been set.
*
* Since: 2.12
......
......@@ -1013,7 +1013,7 @@ gtk_entry_completion_get_entry (GtkEntryCompletion *completion)
/**
* gtk_entry_completion_set_model:
* @completion: A #GtkEntryCompletion.
* @model: The #GtkTreeModel.
* @model: (allow-none): The #GtkTreeModel.
*
* Sets the model for a #GtkEntryCompletion. If @completion already has
* a model set, it will remove it before setting the new model.
......
......@@ -1288,7 +1288,7 @@ gtk_expander_new (const gchar *label)
/**
* gtk_expander_new_with_mnemonic:
* @label: the text of the label with an underscore in front of the
* @label: (allow-none): the text of the label with an underscore in front of the
* mnemonic character
*
* Creates a new expander using @label as the text of the label.
......@@ -1495,7 +1495,7 @@ gtk_expander_get_spacing (GtkExpander *expander)
/**
* gtk_expander_set_label:
* @expander: a #GtkExpander
* @label: a string
* @label: (allow-none): a string
*
* Sets the text of the label of the expander to @label.
*
......@@ -1674,7 +1674,7 @@ gtk_expander_get_use_markup (GtkExpander *expander)
/**
* gtk_expander_set_label_widget:
* @expander: a #GtkExpander
* @label_widget: the new label widget
* @label_widget: (allow-none): the new label widget
*
* Set the label widget for the expander. This is the widget
* that will appear embedded alongside the expander arrow.
......
......@@ -661,7 +661,7 @@ files_to_strings (GSList *files,
* folder cannot be represented as local filenames they will be ignored. (See
* gtk_file_chooser_get_uris())
*
* Return value: a #GSList containing the filenames of all selected
* Return value: (element-type utf8) (transfer full): a #GSList containing the filenames of all selected
* files and subfolders in the current folder. Free the returned list
* with g_slist_free(), and the filenames with g_free().
*
......@@ -965,7 +965,7 @@ gtk_file_chooser_unselect_all (GtkFileChooser *chooser)
* Lists all the selected files and subfolders in the current folder of
* @chooser. The returned names are full absolute URIs.
*
* Return value: a #GSList containing the URIs of all selected
* Return value: (element-type utf8) (transfer full): a #GSList containing the URIs of all selected
* files and subfolders in the current folder. Free the returned list
* with g_slist_free(), and the filenames with g_free().
*
......@@ -1156,7 +1156,7 @@ gtk_file_chooser_unselect_file (GtkFileChooser *chooser,
* Lists all the selected files and subfolders in the current folder of @chooser
* as #GFile. An internal function, see gtk_file_chooser_get_uris().
*
* Return value: a #GSList containing a #GFile for each selected
* Return value: (element-type utf8) (transfer full): a #GSList containing a #GFile for each selected
* file and subfolder in the current folder. Free the returned list
* with g_slist_free(), and the files with g_object_unref().
*
......@@ -1666,7 +1666,7 @@ gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
* Lists the current set of user-selectable filters; see
* gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
*
* Return value: a #GSList containing the current set of
* Return value: (element-type utf8) (transfer container): a #GSList containing the current set of
* user selectable filters. The contents of the list are
* owned by GTK+, but you must free the list itself with
* g_slist_free() when you are done with it.
......@@ -1807,7 +1807,7 @@ gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser,
* Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder().
*
* Return value: A list of folder filenames, or %NULL if there are no shortcut
* Return value: (element-type utf8) (transfer full): A list of folder filenames, or %NULL if there are no shortcut
* folders. Free the returned list with g_slist_free(), and the filenames with
* g_free().
*
......@@ -1904,7 +1904,7 @@ gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser,
* Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder_uri().
*
* Return value: A list of folder URIs, or %NULL if there are no shortcut
* Return value: (element-type utf8) (transfer full): A list of folder URIs, or %NULL if there are no shortcut
* folders. Free the returned list with g_slist_free(), and the URIs with
* g_free().
*
......
......@@ -306,7 +306,7 @@ gtk_frame_forall (GtkContainer *container,
/**
* gtk_frame_set_label:
* @frame: a #GtkFrame
* @label: the text to use as the label of the frame
* @label: (allow-none): the text to use as the label of the frame
*
* Sets the text of the label. If @label is %NULL,
* the current label is removed.
......
......@@ -1620,7 +1620,7 @@ render_fallback_image (GtkStyle *style,
/**
* gtk_icon_set_render_icon:
* @icon_set: a #GtkIconSet
* @style: a #GtkStyle associated with @widget, or %NULL
* @style: (allow-none): a #GtkStyle associated with @widget, or %NULL
* @direction: text direction
* @state: widget state
* @size: icon size. A size of (GtkIconSize)-1
......@@ -1762,7 +1762,7 @@ gtk_icon_set_add_source (GtkIconSet *icon_set,
/**
* gtk_icon_set_get_sizes:
* @icon_set: a #GtkIconSet
* @sizes: return location for array of sizes
* @sizes: (array length=n_sizes) (out): return location for array of sizes
* @n_sizes: location to store number of elements in returned array
*
* Obtains a list of icon sizes this icon set can render. The returned
......@@ -2033,7 +2033,7 @@ gtk_icon_source_set_filename (GtkIconSource *source,
/**
* gtk_icon_source_set_icon_name
* @source: a #GtkIconSource
* @icon_name: name of icon to use
* @icon_name: (allow-none): name of icon to use
*
* Sets the name of an icon to look up in the current icon theme
* to use as a base image when creating icon variants for #GtkIconSet.
......
......@@ -276,7 +276,7 @@ gtk_icon_theme_new (void)
* Gets the icon theme for the default screen. See
* gtk_icon_theme_get_for_screen().
*
* Return value: A unique #GtkIconTheme associated with
* Return value: (transfer none): A unique #GtkIconTheme associated with
* the default screen. This icon theme is associated with
* the screen and can be used as long as the screen
* is open. Do not ref or unref it.
......@@ -302,7 +302,7 @@ gtk_icon_theme_get_default (void)
* and setting the screen yourself; by using this function
* a single icon theme object will be shared between users.
*
* Return value: A unique #GtkIconTheme associated with
* Return value: (transfer none): A unique #GtkIconTheme associated with
* the given screen. This icon theme is associated with
* the screen and can be used as long as the screen
* is open. Do not ref or unref it.
......@@ -1739,7 +1739,7 @@ add_key_to_list (gpointer key,
* but will typically include such values as "Applications" and
* "MimeTypes".
*
* Return value: a #GList list holding the names of all the
* Return value: (element-type utf8) (transfer none): a #GList list holding the names of all the
* icons in the theme. You must first free each element
* in the list with g_free(), then free the list itself
* with g_list_free().
......@@ -1801,7 +1801,7 @@ gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
* Gets the list of contexts available within the current
* hierarchy of icon themes
*
* Return value: a #GList list holding the names of all the
* Return value: (element-type utf8) (transfer full): a #GList list holding the names of all the
* contexts in the theme. You must first free each element
* in the list with g_free(), then free the list itself
* with g_list_free().
......@@ -2750,7 +2750,7 @@ gtk_icon_info_get_filename (GtkIconInfo *icon_info)
* %GTK_ICON_LOOKUP_USE_BUILTIN to
* gtk_icon_theme_lookup_icon().
*
* Return value: the built-in image pixbuf, or %NULL. No
* Return value: (transfer none): the built-in image pixbuf, or %NULL. No
* extra reference is added to the returned pixbuf, so if
* you want to keep it around, you must use g_object_ref().
* The returned image must not be modified.
......
......@@ -1992,7 +1992,7 @@ gtk_icon_view_stop_editing (GtkIconView *icon_view,
* gtk_icon_view_set_cursor:
* @icon_view: A #GtkIconView
* @path: A #GtkTreePath
* @cell: One of the cell renderers of @icon_view, or %NULL
* @cell: (allow-none): One of the cell renderers of @icon_view, or %NULL