GNOME.org
 

[gtk+/gi-annotations-2: 5/12] [GI] Mark callbacks' context parameter with (closure) annotation.

commit be501e9cb18a9b7b1795e1dfadaf9b49b0cf2fab
Author: Pavel Holejsovsky <pholejs src gnome org>
Date:   Tue Jan 18 06:28:24 2011 +0100

    [GI] Mark callbacks' context parameter with (closure) annotation.

 docs/reference/gtk/tmpl/gtkprintoperation.sgml |    9 +++------
 gdk/gdkevents.h                                |    2 +-
 gtk/gtkaccelgroup.h                            |    2 +-
 gtk/gtkassistant.h                             |    2 +-
 gtk/gtkcellarea.h                              |    4 ++--
 gtk/gtkfilefilter.h                            |    2 +-
 gtk/gtkprinter.h                               |    2 +-
 gtk/gtkprintoperation.h                        |   11 +++++++++++
 gtk/gtktreemodelfilter.h                       |    4 ++--
 gtk/gtktreeselection.h                         |    4 ++--
 gtk/gtktreeview.h                              |    6 +++---
 11 files changed, 28 insertions(+), 20 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/gtkprintoperation.sgml b/docs/reference/gtk/tmpl/gtkprintoperation.sgml
index 00cc328..0b04460 100644
--- a/docs/reference/gtk/tmpl/gtkprintoperation.sgml
+++ b/docs/reference/gtk/tmpl/gtkprintoperation.sgml
@@ -630,14 +630,11 @@ The #GQuark used for #GtkPrintError errors.
 
 <!-- ##### USER_FUNCTION GtkPageSetupDoneFunc ##### -->
 <para>
-The type of function that is passed to gtk_print_run_page_setup_dialog_async().
-This function will be called when the page setup dialog is dismissed, and
-also serves as destroy notify for @data.
+
 </para>
 
- page_setup: the #GtkPageSetup that has been
- data: user data that has been passed to 
-       gtk_print_run_page_setup_dialog_async().
+ page_setup:
+ data:
 
 
 <!-- ##### FUNCTION gtk_print_run_page_setup_dialog_async ##### -->
diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h
index b7e5ed3..258be49 100644
--- a/gdk/gdkevents.h
+++ b/gdk/gdkevents.h
@@ -100,7 +100,7 @@ typedef union  _GdkEvent	    GdkEvent;
 /**
  * GdkEventFunc:
  * @event: the #GdkEvent to process.
- * @data: user data set when the event handler was installed with
+ * @data: (closure): user data set when the event handler was installed with
  *   gdk_event_handler_set().
  *
  * Specifies the type of function passed to gdk_event_handler_set() to
diff --git a/gtk/gtkaccelgroup.h b/gtk/gtkaccelgroup.h
index 5efe4fa..3195a91 100644
--- a/gtk/gtkaccelgroup.h
+++ b/gtk/gtkaccelgroup.h
@@ -71,7 +71,7 @@ typedef gboolean (*GtkAccelGroupActivate) (GtkAccelGroup  *accel_group,
  * GtkAccelGroupFindFunc:
  * @key: 
  * @closure: 
- * @data: 
+ * @data: (closure):
  * 
  * Since: 2.2
  */
diff --git a/gtk/gtkassistant.h b/gtk/gtkassistant.h
index ea3ae81..62f9ead 100644
--- a/gtk/gtkassistant.h
+++ b/gtk/gtkassistant.h
@@ -111,7 +111,7 @@ struct _GtkAssistantClass
 /**
  * GtkAssistantPageFunc:
  * @current_page: The page number used to calculate the next page.
- * @data: user data.
+ * @data: (closure): user data.
  *
  * A function used by gtk_assistant_set_forward_page_func() to know which
  * is the next page given a current one. It's called both for computing the
diff --git a/gtk/gtkcellarea.h b/gtk/gtkcellarea.h
index 78d5e95..2b0f707 100644
--- a/gtk/gtkcellarea.h
+++ b/gtk/gtkcellarea.h
@@ -62,7 +62,7 @@ typedef struct _GtkCellAreaContext       GtkCellAreaContext;
 /**
  * GtkCellCallback:
  * @renderer: the cell renderer to operate on
- * @data: user-supplied data
+ * @data: (closure): user-supplied data
  *
  * The type of the callback functions used for iterating over
  * the cell renderers of a #GtkCellArea, see gtk_cell_area_foreach().
@@ -79,7 +79,7 @@ typedef gboolean    (*GtkCellCallback) (GtkCellRenderer  *renderer,
  *     provided to gtk_cell_area_foreach_alloc().
  * @cell_background: the background area for @renderer inside the
  *     background area provided to gtk_cell_area_foreach_alloc().
- * @data: user-supplied data
+ * @data: (closure): user-supplied data
  *
  * The type of the callback functions used for iterating over the
  * cell renderers and their allocated areas inside a #GtkCellArea,
diff --git a/gtk/gtkfilefilter.h b/gtk/gtkfilefilter.h
index c566ef1..02e2775 100644
--- a/gtk/gtkfilefilter.h
+++ b/gtk/gtkfilefilter.h
@@ -58,7 +58,7 @@ typedef enum {
  * GtkFileFilterFunc:
  * @filter_info: a #GtkFileFilterInfo that is filled according
  *   to the @needed flags passed to gtk_file_filter_add_custom()
- * @data: user data passed to gtk_file_filter_add_custom()
+ * @data: (closure): user data passed to gtk_file_filter_add_custom()
  *
  * The type of function that is used with custom filters, see
  * gtk_file_filter_add_custom().
diff --git a/gtk/gtkprinter.h b/gtk/gtkprinter.h
index ba7506a..f2c18c1 100644
--- a/gtk/gtkprinter.h
+++ b/gtk/gtkprinter.h
@@ -124,7 +124,7 @@ gboolean                 gtk_printer_get_hard_margins      (GtkPrinter       *pr
 /**
  * GtkPrinterFunc:
  * @printer: a #GtkPrinter
- * @data: user data passed to gtk_enumerate_printers()
+ * @data: (closure): user data passed to gtk_enumerate_printers()
  *
  * The type of function passed to gtk_enumerate_printers().
  * Note that you need to ref @printer, if you want to keep
diff --git a/gtk/gtkprintoperation.h b/gtk/gtkprintoperation.h
index bba15cc..5c2b216 100644
--- a/gtk/gtkprintoperation.h
+++ b/gtk/gtkprintoperation.h
@@ -196,6 +196,17 @@ GtkPageSetup           *gtk_print_run_page_setup_dialog            (GtkWindow
 								    GtkPageSetup       *page_setup,
 								    GtkPrintSettings   *settings);
 
+/**
+ * GtkPageSetupDoneFunc:
+ * @page_setup: the #GtkPageSetup that has been
+ * @data: (closure): user data that has been passed to 
+ *        gtk_print_run_page_setup_dialog_async().
+ *
+ * The type of function that is passed to
+ * gtk_print_run_page_setup_dialog_async().  This function will be
+ * called when the page setup dialog is dismissed, and also serves as
+ * destroy notify for @data.
+ */
 typedef void  (* GtkPageSetupDoneFunc) (GtkPageSetup *page_setup,
 					gpointer      data);
 
diff --git a/gtk/gtktreemodelfilter.h b/gtk/gtktreemodelfilter.h
index b8c3376..b887a0a 100644
--- a/gtk/gtktreemodelfilter.h
+++ b/gtk/gtktreemodelfilter.h
@@ -41,7 +41,7 @@ G_BEGIN_DECLS
  * @model: the child model of the #GtkTreeModelFilter
  * @iter: a #GtkTreeIter pointing to the row in @model whose visibility
  *   is determined
- * @data: user data given to gtk_tree_model_filter_set_visible_func()
+ * @data: (closure): user data given to gtk_tree_model_filter_set_visible_func()
  *
  * A function which decides whether the row indicated by @iter is visible.
  *
@@ -58,7 +58,7 @@ typedef gboolean (* GtkTreeModelFilterVisibleFunc) (GtkTreeModel *model,
  * @value: A #GValue which is already initialized for with the correct type for
  *  the column @column.
  * @column: the column whose display value is determined
- * @data: user data given to gtk_tree_model_filter_set_modify_func()
+ * @data: (closure): user data given to gtk_tree_model_filter_set_modify_func()
  *
  * A function which calculates display values from raw values in the model.
  * It must fill @value with the display value for the column @column in the
diff --git a/gtk/gtktreeselection.h b/gtk/gtktreeselection.h
index 36cfafa..9dfdb9f 100644
--- a/gtk/gtktreeselection.h
+++ b/gtk/gtktreeselection.h
@@ -44,7 +44,7 @@ typedef struct _GtkTreeSelectionPrivate      GtkTreeSelectionPrivate;
  * @model: A #GtkTreeModel being viewed
  * @path: The #GtkTreePath of the row in question
  * @path_currently_selected: %TRUE, if the path is currently selected
- * @data: user data
+ * @data: (closure): user data
  *
  * A function used by gtk_tree_selection_set_select_function() to filter
  * whether or not a row may be selected.  It is called whenever a row's
@@ -64,7 +64,7 @@ typedef gboolean (* GtkTreeSelectionFunc)    (GtkTreeSelection  *selection,
  * @model: The #GtkTreeModel being viewed
  * @path: The #GtkTreePath of a selected row
  * @iter: A #GtkTreeIter pointing to a selected row
- * @data: user data
+ * @data: (closure): user data
  *
  * A function used by gtk_tree_selection_selected_foreach() to map all
  * selected rows.  It will be called on every selected row in the view.
diff --git a/gtk/gtktreeview.h b/gtk/gtktreeview.h
index 9e2227b..80aa134 100644
--- a/gtk/gtktreeview.h
+++ b/gtk/gtktreeview.h
@@ -129,7 +129,7 @@ struct _GtkTreeViewClass
  * @column: The #GtkTreeViewColumn being dragged
  * @prev_column: A #GtkTreeViewColumn on one side of @column
  * @next_column: A #GtkTreeViewColumn on the other side of @column
- * @data: user data
+ * @data: (closure): user data
  *
  * Function type for determining whether @column can be dropped in a
  * particular spot (as determined by @prev_column and @next_column).  In
@@ -167,7 +167,7 @@ typedef void     (* GtkTreeViewMappingFunc)    (GtkTreeView             *tree_vi
  * @key: the key string to compare with
  * @iter: a #GtkTreeIter pointing the row of @model that should be compared
  *  with @key.
- * @search_data: user data from gtk_tree_view_set_search_equal_func()
+ * @search_data: (closure): user data from gtk_tree_view_set_search_equal_func()
  *
  * A function used for checking whether a row in @model matches
  * a search key string entered by the user. Note the return value
@@ -186,7 +186,7 @@ typedef gboolean (*GtkTreeViewSearchEqualFunc) (GtkTreeModel            *model,
  * GtkTreeViewRowSeparatorFunc:
  * @model: the #GtkTreeModel
  * @iter: a #GtkTreeIter pointing at a row in @model
- * @data: user data
+ * @data: (closure): user data
  *
  * Function type for determining whether the row pointed to by @iter should
  * be rendered as a separator. A common way to implement this is to have a
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]