[gtk+/gi-annotations: 31/31] Update GI annotations in GDK.
- From: Pavel Holejsovsky <pholejs src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/gi-annotations: 31/31] Update GI annotations in GDK.
- Date: Mon, 17 Jan 2011 05:53:26 +0000 (UTC)
commit 5fbc0f94c5a74c04f24b73806e75ce0c9fd61588
Author: Pavel Holejsovsky <pholejs src gnome org>
Date: Sat Jan 8 19:17:21 2011 +0100
Update GI annotations in GDK.
gdk/gdk.c | 15 +++++---
gdk/gdkcursor.c | 4 +-
gdk/gdkdevice.c | 31 ++++++++--------
gdk/gdkdisplay.c | 13 ++++---
gdk/gdkdisplaymanager.c | 4 +-
gdk/gdkdnd.c | 2 +-
gdk/gdkevents.c | 8 ++--
gdk/gdkevents.h | 2 +-
gdk/gdkkeys.c | 17 +++++----
gdk/gdkoffscreenwindow.c | 2 +-
gdk/gdkpango.c | 8 +++--
gdk/gdkrectangle.c | 6 ++--
gdk/gdkrgba.c | 6 ++--
gdk/gdkselection.c | 9 +++--
gdk/gdkvisual.c | 8 +++--
gdk/gdkwindow.c | 83 ++++++++++++++++++++++++--------------------
gdk/x11/gdkdisplay-x11.c | 3 +-
gdk/x11/gdkselection-x11.c | 21 ++++++-----
gdk/x11/gdkvisual-x11.c | 4 +-
19 files changed, 134 insertions(+), 112 deletions(-)
---
diff --git a/gdk/gdk.c b/gdk/gdk.c
index 9bf97e5..47e4742 100644
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -268,7 +268,7 @@ gdk_pre_parse_libgtk_only (void)
/**
* gdk_parse_args:
* @argc: the number of command line arguments.
- * @argv: the array of command line arguments.
+ * @argv: (inout) (array length=argc): the array of command line arguments.
*
* Parse command line arguments, and store for future
* use by calls to gdk_display_open().
@@ -707,7 +707,7 @@ gdk_threads_init (void)
}
/**
- * gdk_threads_set_lock_functions:
+ * gdk_threads_set_lock_functions: (skip)
* @enter_fn: function called to guard GDK
* @leave_fn: function called to release the guard
*
@@ -777,7 +777,7 @@ gdk_threads_dispatch_free (gpointer data)
/**
* gdk_threads_add_idle_full:
* @priority: the priority of the idle source. Typically this will be in the
- * range btweeen #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
+ * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
* @function: function to call
* @data: data to pass to @function
* @notify: (allow-none): function to call when the idle is removed, or %NULL
@@ -827,6 +827,7 @@ gdk_threads_dispatch_free (gpointer data)
* Return value: the ID (greater than 0) of the event source.
*
* Since: 2.12
+ * Rename to: gdk_threads_add_idle
*/
guint
gdk_threads_add_idle_full (gint priority,
@@ -850,7 +851,7 @@ gdk_threads_add_idle_full (gint priority,
}
/**
- * gdk_threads_add_idle:
+ * gdk_threads_add_idle: (skip)
* @function: function to call
* @data: data to pass to @function
*
@@ -929,6 +930,7 @@ gdk_threads_add_idle (GSourceFunc function,
* Return value: the ID (greater than 0) of the event source.
*
* Since: 2.12
+ * Rename to: gdk_threads_add_timeout
*/
guint
gdk_threads_add_timeout_full (gint priority,
@@ -954,7 +956,7 @@ gdk_threads_add_timeout_full (gint priority,
}
/**
- * gdk_threads_add_timeout:
+ * gdk_threads_add_timeout: (skip)
* @interval: the time between calls to the function, in milliseconds
* (1/1000ths of a second)
* @function: function to call
@@ -995,6 +997,7 @@ gdk_threads_add_timeout (guint interval,
* Return value: the ID (greater than 0) of the event source.
*
* Since: 2.14
+ * Rename to: gdk_threads_add_timeout_seconds
*/
guint
gdk_threads_add_timeout_seconds_full (gint priority,
@@ -1020,7 +1023,7 @@ gdk_threads_add_timeout_seconds_full (gint priority,
}
/**
- * gdk_threads_add_timeout_seconds:
+ * gdk_threads_add_timeout_seconds: (skip)
* @interval: the time between calls to the function, in seconds
* @function: function to call
* @data: data to pass to @function
diff --git a/gdk/gdkcursor.c b/gdk/gdkcursor.c
index fe5f38c..f9a5a6e 100644
--- a/gdk/gdkcursor.c
+++ b/gdk/gdkcursor.c
@@ -150,7 +150,7 @@ gdk_cursor_init (GdkCursor *cursor)
*
* Adds a reference to @cursor.
*
- * Return value: Same @cursor that was passed in
+ * Return value: (transfer full): Same @cursor that was passed in
*
* Deprecated: 3.0: Use g_object_ref() instead
*/
@@ -355,7 +355,7 @@ gdk_cursor_new_from_pixbuf (GdkDisplay *display,
return GDK_DISPLAY_GET_CLASS (display)->get_cursor_for_pixbuf (display, pixbuf, x, y);
}
-/**
+/**
* gdk_cursor_get_display:
* @cursor: a #GdkCursor.
*
diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c
index 1b772ba..c4ca8cf 100644
--- a/gdk/gdkdevice.c
+++ b/gdk/gdkdevice.c
@@ -377,7 +377,7 @@ gdk_device_get_property (GObject *object,
}
/**
- * gdk_device_get_state:
+ * gdk_device_get_state: (skip)
* @device: a #GdkDevice.
* @window: a #GdkWindow.
* @axes: an array of doubles to store the values of the axes of @device in,
@@ -493,12 +493,12 @@ gdk_device_get_window_at_position (GdkDevice *device,
}
/**
- * gdk_device_get_history:
+ * gdk_device_get_history: (skip)
* @device: a #GdkDevice
* @window: the window with respect to which which the event coordinates will be reported
* @start: starting timestamp for range of events to return
* @stop: ending timestamp for the range of events to return
- * @events: (array length=n_events) (out) (transfer none): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
+ * @events: (array length=n_events) (out) (transfer full): location to store a newly-allocated array of #GdkTimeCoord, or %NULL
* @n_events: location to store the length of @events, or %NULL
*
* Obtains the motion history for a pointer device; given a starting and
@@ -554,8 +554,8 @@ _gdk_device_allocate_history (GdkDevice *device,
}
/**
- * gdk_device_free_history:
- * @events: (inout) (transfer none): an array of #GdkTimeCoord.
+ * gdk_device_free_history: (skip)
+ * @events: (array length=n_events): an array of #GdkTimeCoord.
* @n_events: the length of the array.
*
* Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
@@ -697,8 +697,8 @@ gdk_device_get_n_keys (GdkDevice *device)
* gdk_device_get_key:
* @device: a #GdkDevice.
* @index_: the index of the macro button to get.
- * @keyval: return value for the keyval.
- * @modifiers: return value for modifiers.
+ * @keyval: (out): return value for the keyval.
+ * @modifiers: (out): return value for modifiers.
*
* If @index_ has a valid keyval, this function will return %TRUE
* and fill in @keyval and @modifiers with the keyval settings.
@@ -912,9 +912,10 @@ _gdk_device_set_associated_device (GdkDevice *device,
* the list of slave devices attached to it, otherwise it will return
* %NULL
*
- * Returns: (transfer container): the list of slave devices, or %NULL. The
- * list must be freed with g_list_free(), the contents of the list
- * are owned by GTK+ and should not be freed.
+ * Returns: (transfer container) (element-type GdkDevice): the list of
+ * slave devices, or %NULL. The list must be freed with
+ * g_list_free(), the contents of the list are owned by GTK+
+ * and should not be freed.
**/
GList *
gdk_device_list_slave_devices (GdkDevice *device)
@@ -1023,9 +1024,9 @@ gdk_device_list_axes (GdkDevice *device)
}
/**
- * gdk_device_get_axis_value:
+ * gdk_device_get_axis_value: (skip)
* @device: a pointer #GdkDevice.
- * @axes: pointer to an array of axes
+ * @axes: (array): pointer to an array of axes
* @axis_label: #GdkAtom with the axis label.
* @value: location to store the found value.
*
@@ -1070,11 +1071,11 @@ gdk_device_get_axis_value (GdkDevice *device,
}
/**
- * gdk_device_get_axis:
+ * gdk_device_get_axis: (skip)
* @device: a #GdkDevice
- * @axes: pointer to an array of axes
+ * @axes: (array): pointer to an array of axes
* @use: the use to look for
- * @value: location to store the found value.
+ * @value: (out): location to store the found value.
*
* Interprets an array of double as axis values for a given device,
* and locates the value in the array for a given axis use.
diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
index fa2e645..c4f0e4b 100644
--- a/gdk/gdkdisplay.c
+++ b/gdk/gdkdisplay.c
@@ -597,7 +597,7 @@ _gdk_display_enable_motion_hints (GdkDisplay *display,
/**
* gdk_display_get_pointer:
* @display: a #GdkDisplay
- * @screen: (allow-none): location to store the screen that the
+ * @screen: (out) (allow-none): location to store the screen that the
* cursor is on, or %NULL.
* @x: (out) (allow-none): location to store root window X coordinate of pointer, or %NULL.
* @y: (out) (allow-none): location to store root window Y coordinate of pointer, or %NULL.
@@ -1571,7 +1571,8 @@ gdk_display_supports_clipboard_persistence (GdkDisplay *display)
* @display: a #GdkDisplay
* @clipboard_window: a #GdkWindow belonging to the clipboard owner
* @time_: a timestamp
- * @targets: an array of targets that should be saved, or %NULL
+ * @targets: (array length=n_targets): an array of targets
+ * that should be saved, or %NULL
* if all available targets should be saved.
* @n_targets: length of the @targets array
*
@@ -1694,7 +1695,7 @@ gdk_event_send_client_message_for_display (GdkDisplay *display,
}
/**
- * gdk_display_add_client_message_filter:
+ * gdk_display_add_client_message_filter: (skip)
* @display: a #GdkDisplay for which this message filter applies
* @message_type: the type of ClientMessage events to receive.
* This will be checked against the @message_type field
@@ -1718,7 +1719,7 @@ gdk_display_add_client_message_filter (GdkDisplay *display,
}
/**
- * gdk_add_client_message_filter:
+ * gdk_add_client_message_filter: (skip)
* @message_type: the type of ClientMessage events to receive. This will be
* checked against the <structfield>message_type</structfield> field of the
* XClientMessage event struct.
@@ -1756,7 +1757,7 @@ gdk_display_real_get_app_launch_context (GdkDisplay *display)
* Returns a #GdkAppLaunchContext suitable for launching
* applications on the given display.
*
- * Returns: a new #GdkAppLaunchContext for @display.
+ * Returns: (transfer full): a new #GdkAppLaunchContext for @display.
* Free with g_object_unref() when done
*
* Since: 3.0
@@ -1771,7 +1772,7 @@ gdk_display_get_app_launch_context (GdkDisplay *display)
* gdk_drag_get_protocol_for_display:
* @display: the #GdkDisplay where the destination window resides
* @xid: the windowing system id of the destination window.
- * @protocol: location where the supported DND protocol is returned.
+ * @protocol: (out): location where the supported DND protocol is returned.
*
* Finds out the DND protocol supported by a window.
*
diff --git a/gdk/gdkdisplaymanager.c b/gdk/gdkdisplaymanager.c
index 79ed85a..160404d 100644
--- a/gdk/gdkdisplaymanager.c
+++ b/gdk/gdkdisplaymanager.c
@@ -335,7 +335,7 @@ gdk_display_manager_open_display (GdkDisplayManager *manager,
*
* Finds or creates an atom corresponding to a given string.
*
- * Returns: the atom corresponding to @atom_name.
+ * Returns: (transfer none): the atom corresponding to @atom_name.
*/
GdkAtom
gdk_atom_intern (const gchar *atom_name,
@@ -361,7 +361,7 @@ gdk_atom_intern (const gchar *atom_name,
* ever unload the module again (e.g. do not use this function in
* GTK+ theme engines).
*
- * Returns: the atom corresponding to @atom_name
+ * Returns: (transfer none): the atom corresponding to @atom_name
*
* Since: 2.10
*/
diff --git a/gdk/gdkdnd.c b/gdk/gdkdnd.c
index bb2e6a8..fd54a8a 100644
--- a/gdk/gdkdnd.c
+++ b/gdk/gdkdnd.c
@@ -445,7 +445,7 @@ gdk_drag_drop_succeeded (GdkDragContext *context)
*
* Returns the selection atom for the current source window.
*
- * Return value: the selection atom, or %GDK_NONE
+ * Return value: (transfer none): the selection atom, or %GDK_NONE
*/
GdkAtom
gdk_drag_get_selection (GdkDragContext *context)
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 1878799..bc81cf2 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -917,7 +917,7 @@ gdk_event_get_root_coords (const GdkEvent *event,
/**
* gdk_event_get_axis:
* @event: a #GdkEvent
- * @axis_use: (out): the axis use to look for
+ * @axis_use: the axis use to look for
* @value: (out): location to store the value found
*
* Extract the axis value for a particular axis use from
@@ -1161,7 +1161,7 @@ gdk_event_set_source_device (GdkEvent *event,
*
* If the event does not contain device field, this function will return %NULL.
*
- * Returns: a #GdkDevice, or %NULL.
+ * Returns: (transfer none): a #GdkDevice, or %NULL.
*
* Since: 3.0
**/
@@ -1256,7 +1256,7 @@ gdk_events_get_axis_distances (GdkEvent *event1,
* gdk_events_get_distance:
* @event1: first #GdkEvent
* @event2: second #GdkEvent
- * @distance: return location for the distance
+ * @distance: (out): return location for the distance
*
* If both events have X/Y information, the distance between both coordinates
* (as in a straight line going from @event1 to @event2) will be returned.
@@ -1279,7 +1279,7 @@ gdk_events_get_distance (GdkEvent *event1,
* gdk_events_get_angle:
* @event1: first #GdkEvent
* @event2: second #GdkEvent
- * @angle: return location for the relative angle between both events
+ * @angle: (out): return location for the relative angle between both events
*
* If both events contain X/Y information, this function will return %TRUE
* and return in @angle the relative angle from @event1 to @event2. The rotation
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/gdk/gdkkeys.c b/gdk/gdkkeys.c
index c992ef5..74d8329 100644
--- a/gdk/gdkkeys.c
+++ b/gdk/gdkkeys.c
@@ -284,7 +284,7 @@ gdk_keyval_is_lower (guint keyval)
return FALSE;
}
-/**
+/**
* gdk_keymap_get_default:
*
* Returns the #GdkKeymap attached to the default display.
@@ -366,8 +366,9 @@ gdk_keymap_get_num_lock_state (GdkKeymap *keymap)
* gdk_keymap_get_entries_for_keyval:
* @keymap: a #GdkKeymap
* @keyval: a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
- * @keys: (out): return location for an array of #GdkKeymapKey
- * @n_keys: (out): return location for number of elements in returned array
+ * @keys: (out) (array length=n_keys) (transfer full): return location
+ * for an array of #GdkKeymapKey
+ * @n_keys: return location for number of elements in returned array
*
* Obtains a list of keycode/group/level combinations that will
* generate @keyval. Groups and levels are two kinds of keyboard mode;
@@ -396,8 +397,10 @@ gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
* gdk_keymap_get_entries_for_keycode:
* @keymap: a #GdkKeymap
* @hardware_keycode: a keycode
- * @keys: (out): return location for array of #GdkKeymapKey, or %NULL
- * @keyvals: (out): return location for array of keyvals, or %NULL
+ * @keys: (out) (array length=n_entries) (transfer full): return
+ * location for array of #GdkKeymapKey, or %NULL
+ * @keyvals: (out) (array length=n_entries) (transfer full): return
+ * location for array of keyvals, or %NULL
* @n_entries: length of @keys and @keyvals
*
* Returns the keyvals bound to @hardware_keycode.
@@ -531,7 +534,7 @@ gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
/**
* gdk_keymap_add_virtual_modifiers:
* @keymap: a #GdkKeymap
- * @state: pointer to the modifier mask to change
+ * @state: (out): pointer to the modifier mask to change
*
* Adds virtual modifiers (i.e. Super, Hyper and Meta) which correspond
* to the real modifiers (i.e Mod2, Mod3, ...) in @modifiers.
@@ -557,7 +560,7 @@ gdk_keymap_add_virtual_modifiers (GdkKeymap *keymap,
/**
* gdk_keymap_map_virtual_modifiers:
* @keymap: a #GdkKeymap
- * @state: pointer to the modifier state to map
+ * @state: (out): pointer to the modifier state to map
*
* Maps the virtual modifiers (i.e. Super, Hyper and Meta) which
* are set in @state to their non-virtual counterparts (i.e. Mod2,
diff --git a/gdk/gdkoffscreenwindow.c b/gdk/gdkoffscreenwindow.c
index fa1518f..b3c53af 100644
--- a/gdk/gdkoffscreenwindow.c
+++ b/gdk/gdkoffscreenwindow.c
@@ -334,7 +334,7 @@ gdk_offscreen_window_get_device_state (GdkWindow *window,
* If you need to keep this around over window resizes, you need to
* add a reference to it.
*
- * Returns: The offscreen surface, or %NULL if not offscreen
+ * Returns: (transfer none): The offscreen surface, or %NULL if not offscreen
*/
cairo_surface_t *
gdk_offscreen_window_get_surface (GdkWindow *window)
diff --git a/gdk/gdkpango.c b/gdk/gdkpango.c
index 907b517..da35208 100644
--- a/gdk/gdkpango.c
+++ b/gdk/gdkpango.c
@@ -190,11 +190,13 @@ layout_iter_get_line_clip_region (PangoLayoutIter *iter,
}
/**
- * gdk_pango_layout_line_get_clip_region:
+ * gdk_pango_layout_line_get_clip_region: (skip)
* @line: a #PangoLayoutLine
* @x_origin: X pixel where you intend to draw the layout line with this clip
* @y_origin: baseline pixel where you intend to draw the layout line with this clip
- * @index_ranges: array of byte indexes into the layout, where even members of array are start indexes and odd elements are end indexes
+ * @index_ranges: (array): array of byte indexes into the layout,
+ * where even members of array are start indexes and odd elements
+ * are end indexes
* @n_ranges: number of ranges in @index_ranges, i.e. half the size of @index_ranges
*
* Obtains a clip region which contains the areas where the given
@@ -239,7 +241,7 @@ gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line,
}
/**
- * gdk_pango_layout_get_clip_region:
+ * gdk_pango_layout_get_clip_region: (skip)
* @layout: a #PangoLayout
* @x_origin: X pixel where you intend to draw the layout with this clip
* @y_origin: Y pixel where you intend to draw the layout with this clip
diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c
index ff68aa5..0676841 100644
--- a/gdk/gdkrectangle.c
+++ b/gdk/gdkrectangle.c
@@ -53,7 +53,7 @@
* gdk_rectangle_union:
* @src1: a #GdkRectangle
* @src2: a #GdkRectangle
- * @dest: return location for the union of @src1 and @src2
+ * @dest: (out): return location for the union of @src1 and @src2
*
* Calculates the union of two rectangles.
* The union of rectangles @src1 and @src2 is the smallest rectangle which
@@ -83,8 +83,8 @@ gdk_rectangle_union (const GdkRectangle *src1,
* gdk_rectangle_intersect:
* @src1: a #GdkRectangle
* @src2: a #GdkRectangle
- * @dest: (out caller-allocates) (allow-none): return location for the
- * intersection of @src1 and @src2, or %NULL
+ * @dest: (out) (allow-none): return location for the intersection of
+ * @src1 and @src2, or %NULL
*
* Calculates the intersection of two rectangles. It is allowed for
* @dest to be the same as either @src1 or @src2. If the rectangles
diff --git a/gdk/gdkrgba.c b/gdk/gdkrgba.c
index 97c4071..de06cb2 100644
--- a/gdk/gdkrgba.c
+++ b/gdk/gdkrgba.c
@@ -272,7 +272,7 @@ gdk_rgba_parse (GdkRGBA *rgba,
/**
* gdk_rgba_hash:
- * @p: a #GdkRGBA pointer.
+ * @p: (type GdkRGBA): a #GdkRGBA pointer.
*
* A hash function suitable for using for a hash
* table that stores #GdkRGBA<!-- -->s.
@@ -294,8 +294,8 @@ gdk_rgba_hash (gconstpointer p)
/**
* gdk_rgba_equal:
- * @p1: a #GdkRGBA pointer.
- * @p2: another #GdkRGBA pointer.
+ * @p1: (type GdkRGBA): a #GdkRGBA pointer.
+ * @p2: (type GdkRGBA): another #GdkRGBA pointer.
*
* Compares two RGBA colors.
*
diff --git a/gdk/gdkselection.c b/gdk/gdkselection.c
index 27adfdf..3e29a4b 100644
--- a/gdk/gdkselection.c
+++ b/gdk/gdkselection.c
@@ -226,7 +226,7 @@ gdk_selection_send_notify_for_display (GdkDisplay *display,
}
/**
- * gdk_selection_property_get:
+ * gdk_selection_property_get: (skip)
* @requestor: the window on which the data is stored
* @data: location to store a pointer to the retrieved data.
If the retrieval failed, %NULL we be stored here, otherwise, it
@@ -282,10 +282,11 @@ gdk_selection_convert (GdkWindow *requestor,
* @display: a #GdkDisplay
* @encoding: an atom representing the encoding of the text
* @format: the format of the property
- * @text: the text to convert
+ * @text: (array length=length): the text to convert
* @length: the length of @text, in bytes
- * @list: location to store the list of strings or %NULL. The
- * list should be freed with g_strfreev().
+ * @list: (out) (array zero-terminated=1): location to store the list
+ * of strings or %NULL. The list should be freed with
+ * g_strfreev().
*
* Converts a text property in the given encoding to
* a list of UTF-8 strings.
diff --git a/gdk/gdkvisual.c b/gdk/gdkvisual.c
index c1b0160..a2338a9 100644
--- a/gdk/gdkvisual.c
+++ b/gdk/gdkvisual.c
@@ -219,8 +219,9 @@ gdk_visual_get_best_with_both (gint depth,
/**
* gdk_query_depths:
- * @depths: (out) (array): return location for available depths
- * @count: (out): return location for number of available depths
+ * @depths: (out) (array length=count) (transfer none): return
+ * location for available depths
+ * @count: return location for number of available depths
*
* This function returns the available bit depths for the default
* screen. It's equivalent to listing the visuals
@@ -240,7 +241,8 @@ gdk_query_depths (gint **depths,
/**
* gdk_query_visual_types:
- * @visual_types: return location for the available visual types
+ * @visual_types: (out) (array length=count) (transfer none): return
+ * location for the available visual types
* @count: return location for the number of available visual types
*
* This function returns the available visual types for the default
diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c
index 30d5c8d..ed96e26 100644
--- a/gdk/gdkwindow.c
+++ b/gdk/gdkwindow.c
@@ -384,7 +384,8 @@ gdk_window_class_init (GdkWindowClass *klass)
* The ::pick-embedded-child signal is emitted to find an embedded
* child at the given position.
*
- * Returns: the #GdkWindow of the embedded child at @x, @y, or %NULL
+ * Returns: (transfer none): the #GdkWindow of the embedded child at
+ * @x, @y, or %NULL
*
* Since: 2.18
*/
@@ -405,8 +406,10 @@ gdk_window_class_init (GdkWindowClass *klass)
* @window: the offscreen window on which the signal is emitted
* @offscreen-x: x coordinate in the offscreen window
* @offscreen-y: y coordinate in the offscreen window
- * @embedder-x: return location for the x coordinate in the embedder window
- * @embedder-y: return location for the y coordinate in the embedder window
+ * @embedder-x: (out) (type double): return location for the x
+ * coordinate in the embedder window
+ * @embedder-y: (out) (type double): return location for the y
+ * coordinate in the embedder window
*
* The ::to-embedder signal is emitted to translate coordinates
* in an offscreen window to its embedder.
@@ -434,8 +437,10 @@ gdk_window_class_init (GdkWindowClass *klass)
* @window: the offscreen window on which the signal is emitted
* @embedder-x: x coordinate in the embedder window
* @embedder-y: y coordinate in the embedder window
- * @offscreen-x: return location for the x coordinate in the offscreen window
- * @offscreen-y: return location for the y coordinate in the offscreen window
+ * @offscreen-x: (out) (type double): return location for the x
+ * coordinate in the offscreen window
+ * @offscreen-y: (out) (type double): return location for the y
+ * coordinate in the offscreen window
*
* The ::from-embedder signal is emitted to translate coordinates
* in the embedder of an offscreen window to the offscreen window.
@@ -2075,7 +2080,7 @@ gdk_window_set_user_data (GdkWindow *window,
/**
* gdk_window_get_user_data:
* @window: a #GdkWindow
- * @data: return location for user data
+ * @data: (out): return location for user data
*
* Retrieves the user data for @window, which is normally the widget
* that @window belongs to. See gdk_window_set_user_data().
@@ -2406,7 +2411,7 @@ gdk_window_peek_children (GdkWindow *window)
}
/**
- * gdk_window_add_filter:
+ * gdk_window_add_filter: (skip)
* @window: a #GdkWindow
* @function: filter callback
* @data: data to pass to filter callback
@@ -2467,7 +2472,7 @@ gdk_window_add_filter (GdkWindow *window,
}
/**
- * gdk_window_remove_filter:
+ * gdk_window_remove_filter: (skip)
* @window: a #GdkWindow
* @function: previously-added filter function
* @data: user data for previously-added filter function
@@ -4431,8 +4436,8 @@ gdk_window_invalidate_maybe_recurse_full (GdkWindow *window,
* gdk_window_invalidate_maybe_recurse:
* @window: a #GdkWindow
* @region: a #cairo_region_t
- * @child_func: function to use to decide if to recurse to a child,
- * %NULL means never recurse.
+ * @child_func: (scope call): function to use to decide if to recurse
+ * to a child, %NULL means never recurse.
* @user_data: data passed to @child_func
*
* Adds @region to the update area for @window. The update area is the
@@ -4780,8 +4785,8 @@ gdk_window_set_debug_updates (gboolean setting)
* @flags: a mask indicating what portions of @geometry are set
* @width: desired width of window
* @height: desired height of the window
- * @new_width: location to store resulting width
- * @new_height: location to store resulting height
+ * @new_width: (out): location to store resulting width
+ * @new_height: (out): location to store resulting height
*
* Constrains a desired width and height according to a
* set of geometry hints (such as minimum and maximum size).
@@ -6584,8 +6589,8 @@ gdk_window_set_background_pattern (GdkWindow *window,
* does not have its own background and reuses the parent's, %NULL is
* returned and you'll have to query it yourself.
*
- * Returns: The pattern to use for the background or %NULL to use the
- * parent's background.
+ * Returns: (transfer none): The pattern to use for the background or
+ * %NULL to use the parent's background.
*
* Since: 2.22
**/
@@ -6622,9 +6627,10 @@ update_cursor_foreach (GdkDisplay *display,
* there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window.
*
- * Return value: a #GdkCursor, or %NULL. The returned object is owned
- * by the #GdkWindow and should not be unreferenced directly. Use
- * gdk_window_set_cursor() to unset the cursor of the window
+ * Return value: (transfer none): a #GdkCursor, or %NULL. The returned
+ * object is owned by the #GdkWindow and should not be unreferenced
+ * directly. Use gdk_window_set_cursor() to unset the cursor of the
+ * window
*
* Since: 2.18
*/
@@ -6686,9 +6692,10 @@ gdk_window_set_cursor (GdkWindow *window,
* there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window.
*
- * Returns: a #GdkCursor, or %NULL. The returned object is owned
- * by the #GdkWindow and should not be unreferenced directly. Use
- * gdk_window_set_cursor() to unset the cursor of the window
+ * Returns: (transfer none): a #GdkCursor, or %NULL. The returned
+ * object is owned by the #GdkWindow and should not be unreferenced
+ * directly. Use gdk_window_set_cursor() to unset the cursor of the
+ * window
*
* Since: 3.0
**/
@@ -6921,8 +6928,8 @@ gdk_window_get_origin (GdkWindow *window,
* @window: a #GdkWindow
* @x: X coordinate in window
* @y: Y coordinate in window
- * @root_x: return location for X coordinate
- * @root_y: return location for Y coordinate
+ * @root_x: (out): return location for X coordinate
+ * @root_y: (out): return location for Y coordinate
*
* Obtains the position of a window position in root
* window coordinates. This is similar to
@@ -10060,8 +10067,8 @@ gdk_window_set_transient_for (GdkWindow *window,
/**
* gdk_window_get_root_origin:
* @window: a toplevel #GdkWindow
- * @x: return location for X position of window frame
- * @y: return location for Y position of window frame
+ * @x: (out): return location for X position of window frame
+ * @y: (out): return location for Y position of window frame
*
* Obtains the top-left corner of the window manager frame in root
* window coordinates.
@@ -10161,8 +10168,8 @@ gdk_window_set_focus_on_map (GdkWindow *window,
/**
* gdk_window_set_icon_list:
* @window: The #GdkWindow toplevel window to set the icon of.
- * @pixbufs: (transfer none) (element-type GdkPixbuf):
- * A list of pixbufs, of different sizes.
+ * @pixbufs: (element-type GdkPixbuf): A list of pixbufs, of different
+ * sizes.
*
* Sets a list of icons for the window. One of these will be used
* to represent the window when it has been iconified. The icon is
@@ -10484,7 +10491,7 @@ gdk_window_set_decorations (GdkWindow *window,
/**
* gdk_window_get_decorations:
* @window: The toplevel #GdkWindow to get the decorations from
- * @decorations: The window decorations will be written here
+ * @decorations: (out): The window decorations will be written here
*
* Returns the decorations set on the GdkWindow with
* gdk_window_set_decorations().
@@ -10670,8 +10677,8 @@ gdk_window_register_dnd (GdkWindow *window)
/**
* gdk_drag_begin:
* @window: the source window for this drag.
- * @targets: (transfer none) (element-type GdkAtom): the offered targets,
- * as list of #GdkAtoms
+ * @targets: (element-type GdkAtom): the offered targets, as list of
+ * #GdkAtoms
*
* Starts a drag and creates a new drag context for it.
* This function assumes that the drag is controlled by the
@@ -10699,8 +10706,8 @@ gdk_drag_begin (GdkWindow *window,
* gdk_drag_begin_for_device:
* @window: the source window for this drag
* @device: the device that controls this drag
- * @targets: (transfer none) (element-type GdkAtom): the offered targets,
- * as list of #GdkAtoms
+ * @targets: (element-type GdkAtom): the offered targets, as list of
+ * #GdkAtoms
*
* Starts a drag and creates a new drag context for it.
*
@@ -10834,9 +10841,9 @@ gdk_test_simulate_button (GdkWindow *window,
* when rounded up).
* @pdelete: if %TRUE, delete the property after retrieving the
* data.
- * @actual_property_type: location to store the actual type of
-* the property.
- * @actual_format: location to store the actual return format of the
+ * @actual_property_type: (out) (transfer none): location to store the
+ * actual type of the property.
+ * @actual_format: (out): location to store the actual return format of the
* data; either 8, 16 or 32 bits.
* @actual_length: location to store the length of the retrieved data, in
* bytes. Data returned in the 32 bit format is stored
@@ -10844,9 +10851,9 @@ gdk_test_simulate_button (GdkWindow *window,
* elements should be be calculated via
* @actual_length / sizeof(glong) to ensure portability to
* 64 bit systems.
- * @data: location to store a pointer to the data. The retrieved
- * data should be freed with g_free() when you are finished
- * using it.
+ * @data: (out) (array length=actual_length) (transfer full): location
+ * to store a pointer to the data. The retrieved data should be
+ * freed with g_free() when you are finished using it.
*
* Retrieves a portion of the contents of a property. If the
* property does not exist, then the function returns %FALSE,
@@ -10889,7 +10896,7 @@ gdk_property_get (GdkWindow *window,
}
/**
- * gdk_property_change:
+ * gdk_property_change: (skip)
* @window: a #GdkWindow
* @property: the property to change
* @type: the new type for the property. If @mode is
diff --git a/gdk/x11/gdkdisplay-x11.c b/gdk/x11/gdkdisplay-x11.c
index e406bb8..b3d77cb 100644
--- a/gdk/x11/gdkdisplay-x11.c
+++ b/gdk/x11/gdkdisplay-x11.c
@@ -1854,7 +1854,8 @@ gdk_x11_lookup_xdisplay (Display *xdisplay)
* Given the root window ID of one of the screen's of a #GdkDisplay,
* finds the screen.
*
- * Return value: the #GdkScreen corresponding to @xrootwin, or %NULL.
+ * Return value: (transfer none): the #GdkScreen corresponding to
+ * @xrootwin, or %NULL.
**/
GdkScreen *
_gdk_x11_display_screen_for_xrootwin (GdkDisplay *display,
diff --git a/gdk/x11/gdkselection-x11.c b/gdk/x11/gdkselection-x11.c
index f13207b..30d2684 100644
--- a/gdk/x11/gdkselection-x11.c
+++ b/gdk/x11/gdkselection-x11.c
@@ -340,7 +340,7 @@ _gdk_x11_display_send_selection_notify (GdkDisplay *display,
* @format: the format of the property
* @text: The text data
* @length: The number of items to transform
- * @list: location to store an array of strings in
+ * @list: (out) (array): location to store an array of strings in
* the encoding of the current locale. This array should be
* freed using gdk_free_text_list().
*
@@ -395,7 +395,7 @@ gdk_x11_display_text_property_to_text_list (GdkDisplay *display,
/**
* gdk_x11_free_text_list:
- * @list: the value stored in the @list parameter by
+ * @list: (array): the value stored in the @list parameter by
* a call to gdk_x11_display_text_property_to_text_list().
*
* Frees the array of strings created by
@@ -576,11 +576,12 @@ _gdk_x11_display_text_property_to_utf8_list (GdkDisplay *display,
* gdk_x11_display_string_to_compound_text:
* @display: the #GdkDisplay where the encoding is defined
* @str: a nul-terminated string
- * @encoding: location to store the encoding atom
+ * @encoding: (out) (transfer none): location to store the encoding atom
* (to be used as the type for the property)
- * @format: location to store the format of the property
- * @ctext: location to store newly allocated data for the property
- * @length: the length of @text, in bytes
+ * @format: (out): location to store the format of the property
+ * @ctext: (out) (array length=length): location to store newly
+ * allocated data for the property
+ * @length: the length of @ctext, in bytes
*
* Convert a string from the encoding of the current
* locale into a form suitable for storing in a window property.
@@ -696,9 +697,9 @@ _gdk_x11_display_utf8_to_string_target (GdkDisplay *display,
* gdk_x11_display_utf8_to_compound_text:
* @display: a #GdkDisplay
* @str: a UTF-8 string
- * @encoding: location to store resulting encoding
- * @format: location to store format of the result
- * @ctext: location to store the data of the result
+ * @encoding: (out): location to store resulting encoding
+ * @format: (out): location to store format of the result
+ * @ctext: (out) (array length=length): location to store the data of the result
* @length: location to store the length of the data
* stored in @ctext
*
@@ -774,7 +775,7 @@ gdk_x11_display_utf8_to_compound_text (GdkDisplay *display,
/**
* gdk_x11_free_compound_text:
- * @ctext: The pointer stored in @ctext from a call to
+ * @ctext: (array): The pointer stored in @ctext from a call to
* gdk_x11_display_string_to_compound_text().
*
* Frees the data returned from gdk_x11_display_string_to_compound_text().
diff --git a/gdk/x11/gdkvisual-x11.c b/gdk/x11/gdkvisual-x11.c
index eb394f6..7d80a12 100644
--- a/gdk/x11/gdkvisual-x11.c
+++ b/gdk/x11/gdkvisual-x11.c
@@ -462,8 +462,8 @@ _gdk_x11_screen_list_visuals (GdkScreen *screen)
*
* Looks up the #GdkVisual for a particular screen and X Visual ID.
*
- * Returns: the #GdkVisual (owned by the screen object), or %NULL
- * if the visual ID wasn't found.
+ * Returns: (transfer none): the #GdkVisual (owned by the screen
+ * object), or %NULL if the visual ID wasn't found.
*
* Since: 2.2
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
