diff options
Diffstat (limited to 'gdk')
| -rw-r--r-- | gdk/gdk.c | 14 | ||||
| -rw-r--r-- | gdk/gdkcolor.c | 10 | ||||
| -rw-r--r-- | gdk/gdkcursor.c | 8 | ||||
| -rw-r--r-- | gdk/gdkdeprecated.c | 4 | ||||
| -rw-r--r-- | gdk/gdkdevice.c | 12 | ||||
| -rw-r--r-- | gdk/gdkdisplay.c | 20 | ||||
| -rw-r--r-- | gdk/gdkdisplaymanager.c | 4 | ||||
| -rw-r--r-- | gdk/gdkdnd.c | 16 | ||||
| -rw-r--r-- | gdk/gdkevents.c | 42 | ||||
| -rw-r--r-- | gdk/gdkframeclock.c | 6 | ||||
| -rw-r--r-- | gdk/gdkkeys.c | 8 | ||||
| -rw-r--r-- | gdk/gdkkeyuni.c | 4 | ||||
| -rw-r--r-- | gdk/gdkpango.c | 8 | ||||
| -rw-r--r-- | gdk/gdkpixbuf-drawable.c | 4 | ||||
| -rw-r--r-- | gdk/gdkrgba.c | 4 | ||||
| -rw-r--r-- | gdk/gdkscreen.c | 28 | ||||
| -rw-r--r-- | gdk/gdkselection.c | 6 | ||||
| -rw-r--r-- | gdk/gdkvisual.c | 28 | ||||
| -rw-r--r-- | gdk/gdkwindow.c | 78 | ||||
| -rw-r--r-- | gdk/quartz/gdkeventloop-quartz.c | 4 | ||||
| -rw-r--r-- | gdk/win32/gdkwindow-win32.c | 2 | ||||
| -rw-r--r-- | gdk/x11/gdkcursor-x11.c | 4 | ||||
| -rw-r--r-- | gdk/x11/gdkdisplay-x11.c | 6 | ||||
| -rw-r--r-- | gdk/x11/gdkmain-x11.c | 6 | ||||
| -rw-r--r-- | gdk/x11/gdkproperty-x11.c | 16 | ||||
| -rw-r--r-- | gdk/x11/gdkscreen-x11.c | 4 | ||||
| -rw-r--r-- | gdk/x11/gdkselection-x11.c | 2 | ||||
| -rw-r--r-- | gdk/x11/gdkvisual-x11.c | 2 | ||||
| -rw-r--r-- | gdk/x11/gdkwindow-x11.c | 6 | ||||
| -rw-r--r-- | gdk/x11/gdkxid.c | 2 |
30 files changed, 179 insertions, 179 deletions
@@ -382,7 +382,7 @@ gdk_get_display_arg_name (void) * display has previously been set, simply returns that. An internal * function that should not be used by applications. * - * Return value: (transfer none): the default display, if it could be + * Returns: (transfer none): the default display, if it could be * opened, otherwise %NULL. **/ GdkDisplay * @@ -701,7 +701,7 @@ gdk_threads_dispatch_free (gpointer data) * } * ]| * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.12 */ @@ -736,7 +736,7 @@ gdk_threads_add_idle_full (gint priority, * * See gdk_threads_add_idle_full(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.12 */ @@ -803,7 +803,7 @@ gdk_threads_add_idle (GSourceFunc function, * } * ]| * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.12 */ @@ -842,7 +842,7 @@ gdk_threads_add_timeout_full (gint priority, * * See gdk_threads_add_timeout_full(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.12 */ @@ -869,7 +869,7 @@ gdk_threads_add_timeout (guint interval, * See g_timeout_add_seconds_full() for a discussion of why it is * a good idea to use this function if you don’t need finer granularity. * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.14 */ @@ -907,7 +907,7 @@ gdk_threads_add_timeout_seconds_full (gint priority, * * For details, see gdk_threads_add_timeout_full(). * - * Return value: the ID (greater than 0) of the event source. + * Returns: the ID (greater than 0) of the event source. * * Since: 2.14 */ diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c index c121593869..92c88f5d6c 100644 --- a/gdk/gdkcolor.c +++ b/gdk/gdkcolor.c @@ -51,7 +51,7 @@ * * The result must be freed using gdk_color_free(). * - * Return value: a copy of @color + * Returns: a copy of @color */ GdkColor* gdk_color_copy (const GdkColor *color) @@ -86,7 +86,7 @@ gdk_color_free (GdkColor *color) * A hash function suitable for using for a hash * table that stores #GdkColors. * - * Return value: The hash function applied to @color + * Returns: The hash function applied to @color */ guint gdk_color_hash (const GdkColor *color) @@ -104,7 +104,7 @@ gdk_color_hash (const GdkColor *color) * * Compares two colors. * - * Return value: %TRUE if the two colors compare equal + * Returns: %TRUE if the two colors compare equal */ gboolean gdk_color_equal (const GdkColor *colora, @@ -138,7 +138,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color, * (White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff” * and “\#ffffffffffff”). * - * Return value: %TRUE if the parsing succeeded + * Returns: %TRUE if the parsing succeeded */ gboolean gdk_color_parse (const gchar *spec, @@ -168,7 +168,7 @@ gdk_color_parse (const gchar *spec, * * The returned string can be parsed by gdk_color_parse(). * - * Return value: a newly-allocated text string + * Returns: a newly-allocated text string * * Since: 2.12 */ diff --git a/gdk/gdkcursor.c b/gdk/gdkcursor.c index 2157bcf2db..914d2fbec4 100644 --- a/gdk/gdkcursor.c +++ b/gdk/gdkcursor.c @@ -153,7 +153,7 @@ gdk_cursor_init (GdkCursor *cursor) * * Adds a reference to @cursor. * - * Return value: (transfer full): Same @cursor that was passed in + * Returns: (transfer full): Same @cursor that was passed in * * Deprecated: 3.0: Use g_object_ref() instead */ @@ -191,7 +191,7 @@ gdk_cursor_unref (GdkCursor *cursor) * * To make the cursor invisible, use %GDK_BLANK_CURSOR. * - * Return value: a new #GdkCursor + * Returns: a new #GdkCursor */ GdkCursor* gdk_cursor_new (GdkCursorType cursor_type) @@ -205,7 +205,7 @@ gdk_cursor_new (GdkCursorType cursor_type) * * Returns the cursor type for this cursor. * - * Return value: a #GdkCursorType + * Returns: a #GdkCursorType * * Since: 2.22 **/ @@ -243,7 +243,7 @@ gdk_cursor_get_cursor_type (GdkCursor *cursor) * -  #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter) * - #GDK_BLANK_CURSOR (Blank cursor). Since 2.16 * - * Return value: a new #GdkCursor + * Returns: a new #GdkCursor * * Since: 2.2 **/ diff --git a/gdk/gdkdeprecated.c b/gdk/gdkdeprecated.c index 56a9ddc654..02a40fb266 100644 --- a/gdk/gdkdeprecated.c +++ b/gdk/gdkdeprecated.c @@ -53,7 +53,7 @@ gdk_pointer_ungrab (guint32 time) * Note that this does not take the inmplicit pointer grab on button * presses into account. * - * Return value: %TRUE if the pointer is currently grabbed by this application. + * Returns: %TRUE if the pointer is currently grabbed by this application. * * Deprecated: 3.0: Use gdk_display_device_is_grabbed() instead. **/ @@ -94,7 +94,7 @@ gdk_keyboard_ungrab (guint32 time) * NOTE: For multihead-aware widgets or applications use * gdk_display_get_window_at_pointer() instead. * - * Return value: (transfer none): window under the mouse pointer + * Returns: (transfer none): window under the mouse pointer * * Deprecated: 3.0: Use gdk_device_get_window_at_position() instead. **/ diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c index 653a0aa2f9..9508a7be13 100644 --- a/gdk/gdkdevice.c +++ b/gdk/gdkdevice.c @@ -597,7 +597,7 @@ gdk_device_get_window_at_position (GdkDevice *device, * more motion events delivered directly, independent of the windowing * system. * - * Return value: %TRUE if the windowing system supports motion history and + * Returns: %TRUE if the windowing system supports motion history and * at least one event was found. **/ gboolean @@ -667,7 +667,7 @@ gdk_device_free_history (GdkTimeCoord **events, * * Determines the name of the device. * - * Return value: a name + * Returns: a name * * Since: 2.20 **/ @@ -685,7 +685,7 @@ gdk_device_get_name (GdkDevice *device) * * Determines whether the pointer follows device motion. * - * Return value: %TRUE if the pointer follows device motion + * Returns: %TRUE if the pointer follows device motion * * Since: 2.20 **/ @@ -704,7 +704,7 @@ gdk_device_get_has_cursor (GdkDevice *device) * * Determines the type of the device. * - * Return value: a #GdkInputSource + * Returns: a #GdkInputSource * * Since: 2.20 **/ @@ -722,7 +722,7 @@ gdk_device_get_source (GdkDevice *device) * * Determines the mode of the device. * - * Return value: a #GdkInputSource + * Returns: a #GdkInputSource * * Since: 2.20 **/ @@ -1169,7 +1169,7 @@ gdk_device_get_axis_value (GdkDevice *device, * Interprets an array of double as axis values for a given device, * and locates the value in the array for a given axis use. * - * Return value: %TRUE if the given axis use was found, otherwise %FALSE + * Returns: %TRUE if the given axis use was found, otherwise %FALSE **/ gboolean gdk_device_get_axis (GdkDevice *device, diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c index 6896197f9d..37ac390a2d 100644 --- a/gdk/gdkdisplay.c +++ b/gdk/gdkdisplay.c @@ -306,7 +306,7 @@ gdk_display_is_closed (GdkDisplay *display) * Gets the next #GdkEvent to be processed for @display, fetching events from the * windowing system if necessary. * - * Return value: the next #GdkEvent to be processed, or %NULL if no events + * Returns: the next #GdkEvent to be processed, or %NULL if no events * are pending. The returned #GdkEvent should be freed with gdk_event_free(). * * Since: 2.2 @@ -331,7 +331,7 @@ gdk_display_get_event (GdkDisplay *display) * not get more events from the windowing system. It only checks the events * that have already been moved to the GDK event queue.) * - * Return value: a copy of the first #GdkEvent on the event queue, or %NULL + * Returns: a copy of the first #GdkEvent on the event queue, or %NULL * if no events are in the queue. The returned #GdkEvent should be freed with * gdk_event_free(). * @@ -1288,7 +1288,7 @@ _gdk_display_pointer_info_foreach (GdkDisplay *display, * Determines information about the current keyboard grab. * This is not public API and must not be used by applications. * - * Return value: %TRUE if this application currently has the + * Returns: %TRUE if this application currently has the * keyboard grabbed. **/ gboolean @@ -1553,7 +1553,7 @@ gdk_display_flush (GdkDisplay *display) * on @display. This window is implicitly created by GDK. * See gdk_window_set_group(). * - * Return value: (transfer none): The default group leader window + * Returns: (transfer none): The default group leader window * for @display * * Since: 2.4 @@ -1573,7 +1573,7 @@ gdk_display_get_default_group (GdkDisplay *display) * Returns whether #GdkEventOwnerChange events will be * sent when the owner of a selection changes. * - * Return value: whether #GdkEventOwnerChange events will + * Returns: whether #GdkEventOwnerChange events will * be sent. * * Since: 2.6 @@ -1595,7 +1595,7 @@ gdk_display_supports_selection_notification (GdkDisplay *display) * Request #GdkEventOwnerChange events for ownership changes * of the selection named by the given atom. * - * Return value: whether #GdkEventOwnerChange events will + * Returns: whether #GdkEventOwnerChange events will * be sent. * * Since: 2.6 @@ -1727,7 +1727,7 @@ gdk_display_supports_composite (GdkDisplay *display) * Returns the list of available input devices attached to @display. * The list is statically allocated and should not be freed. * - * Return value: (transfer none) (element-type GdkDevice): + * Returns: (transfer none) (element-type GdkDevice): * a list of #GdkDevice * * Since: 2.2 @@ -1780,7 +1780,7 @@ gdk_display_get_app_launch_context (GdkDisplay *display) * * Opens a display. * - * Return value: (transfer none): a #GdkDisplay, or %NULL + * Returns: (transfer none): a #GdkDisplay, or %NULL * if the display could not be opened * * Since: 2.2 @@ -2069,7 +2069,7 @@ _gdk_display_create_window (GdkDisplay *display) * * Returns the #GdkKeymap attached to @display. * - * Return value: (transfer none): the #GdkKeymap attached to @display. + * Returns: (transfer none): the #GdkKeymap attached to @display. * * Since: 2.2 */ @@ -2215,7 +2215,7 @@ gdk_error_trap_pop_ignored (void) * sync for you, so you had to gdk_flush() if your last * call to Xlib was not a blocking round trip. * - * Return value: X error code or 0 on success + * Returns: X error code or 0 on success */ gint gdk_error_trap_pop (void) diff --git a/gdk/gdkdisplaymanager.c b/gdk/gdkdisplaymanager.c index 6b28b0a276..6163006a2c 100644 --- a/gdk/gdkdisplaymanager.c +++ b/gdk/gdkdisplaymanager.c @@ -392,7 +392,7 @@ gdk_display_manager_set_default_display (GdkDisplayManager *manager, * * List all currently open displays. * - * Return value: (transfer container) (element-type GdkDisplay): a newly + * Returns: (transfer container) (element-type GdkDisplay): a newly * allocated #GSList of #GdkDisplay objects. Free with g_slist_free() * when you are done with it. * @@ -411,7 +411,7 @@ gdk_display_manager_list_displays (GdkDisplayManager *manager) * * Opens a display. * - * Return value: (transfer none): a #GdkDisplay, or %NULL + * Returns: (transfer none): a #GdkDisplay, or %NULL * if the display could not be opened * * Since: 3.0 diff --git a/gdk/gdkdnd.c b/gdk/gdkdnd.c index 0a7636dab8..d57c8f7285 100644 --- a/gdk/gdkdnd.c +++ b/gdk/gdkdnd.c @@ -51,7 +51,7 @@ * * Retrieves the list of targets of the context. * - * Return value: (transfer none) (element-type GdkAtom): a #GList of targets + * Returns: (transfer none) (element-type GdkAtom): a #GList of targets * * Since: 2.22 **/ @@ -70,7 +70,7 @@ gdk_drag_context_list_targets (GdkDragContext *context) * Determines the bitmask of actions proposed by the source if * gdk_drag_context_get_suggested_action() returns GDK_ACTION_ASK. * - * Return value: the #GdkDragAction flags + * Returns: the #GdkDragAction flags * * Since: 2.22 **/ @@ -88,7 +88,7 @@ gdk_drag_context_get_actions (GdkDragContext *context) * * Determines the suggested drag action of the context. * - * Return value: a #GdkDragAction value + * Returns: a #GdkDragAction value * * Since: 2.22 **/ @@ -106,7 +106,7 @@ gdk_drag_context_get_suggested_action (GdkDragContext *context) * * Determines the action chosen by the drag destination. * - * Return value: a #GdkDragAction value + * Returns: a #GdkDragAction value * * Since: 2.22 **/ @@ -124,7 +124,7 @@ gdk_drag_context_get_selected_action (GdkDragContext *context) * * Returns the #GdkWindow where the DND operation started. * - * Return value: (transfer none): a #GdkWindow + * Returns: (transfer none): a #GdkWindow * * Since: 2.22 **/ @@ -142,7 +142,7 @@ gdk_drag_context_get_source_window (GdkDragContext *context) * * Returns the destination windw for the DND operation. * - * Return value: (transfer none): a #GdkWindow + * Returns: (transfer none): a #GdkWindow * * Since: 3.0 **/ @@ -427,7 +427,7 @@ gdk_drop_finish (GdkDragContext *context, * handling a %GDK_DROP_FINISHED event, its return value is * meaningless at other times. * - * Return value: %TRUE if the drop was successful. + * Returns: %TRUE if the drop was successful. * * Since: 2.6 **/ @@ -445,7 +445,7 @@ gdk_drag_drop_succeeded (GdkDragContext *context) * * Returns the selection atom for the current source window. * - * Return value: (transfer none): the selection atom, or %GDK_NONE + * Returns: (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 1f5bcb2af7..7562e713a4 100644 --- a/gdk/gdkevents.c +++ b/gdk/gdkevents.c @@ -80,7 +80,7 @@ _gdk_event_emit (GdkEvent *event) * Find the first event on the queue that is not still * being filled in. * - * Return value: Pointer to the list node for that event, or NULL. + * Returns: Pointer to the list node for that event, or NULL. **/ GList* _gdk_event_queue_find_first (GdkDisplay *display) @@ -241,7 +241,7 @@ _gdk_event_queue_remove_link (GdkDisplay *display, * Removes and returns the first event from the event * queue that is not still being filled in. * - * Return value: the event, or %NULL. Ownership is transferred + * Returns: the event, or %NULL. Ownership is transferred * to the caller. **/ GdkEvent* @@ -365,7 +365,7 @@ gdk_event_handler_set (GdkEventFunc func, * * Checks if any events are ready to be processed for any display. * - * Return value: %TRUE if any events are pending. + * Returns: %TRUE if any events are pending. */ gboolean gdk_events_pending (void) @@ -406,7 +406,7 @@ gdk_events_pending (void) * on, fetching events from the windowing system if necessary. * See gdk_display_get_event(). * - * Return value: the next #GdkEvent to be processed, or %NULL if no events + * Returns: the next #GdkEvent to be processed, or %NULL if no events * are pending. The returned #GdkEvent should be freed with gdk_event_free(). **/ GdkEvent* @@ -435,7 +435,7 @@ gdk_event_get (void) * If there is an event waiting in the event queue of some open * display, returns a copy of it. See gdk_display_peek_event(). * - * Return value: a copy of the first #GdkEvent on some event queue, or %NULL if no + * Returns: a copy of the first #GdkEvent on some event queue, or %NULL if no * events are in any queues. The returned #GdkEvent should be freed with * gdk_event_free(). **/ @@ -494,7 +494,7 @@ static GHashTable *event_hash = NULL; * * Creates a new event of the given type. All fields are set to 0. * - * Return value: a newly-allocated #GdkEvent. The returned #GdkEvent + * Returns: a newly-allocated #GdkEvent. The returned #GdkEvent * should be freed with gdk_event_free(). * * Since: 2.2 @@ -613,7 +613,7 @@ _gdk_event_get_pointer_emulated (GdkEvent *event) * Copies a #GdkEvent, copying or incrementing the reference count of the * resources associated with it (e.g. #GdkWindow’s and strings). * - * Return value: a copy of @event. The returned #GdkEvent should be freed with + * Returns: a copy of @event. The returned #GdkEvent should be freed with * gdk_event_free(). **/ GdkEvent* @@ -820,7 +820,7 @@ gdk_event_free (GdkEvent *event) * * Extracts the #GdkWindow associated with an event. * - * Return value: (transfer none): The #GdkWindow associated with the event + * Returns: (transfer none): The #GdkWindow associated with the event * * Since: 3.10 */ @@ -839,7 +839,7 @@ gdk_event_get_window (const GdkEvent *event) * Returns the time stamp from @event, if there is one; otherwise * returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME. * - * Return value: time stamp field from @event + * Returns: time stamp field from @event **/ guint32 gdk_event_get_time (const GdkEvent *event) @@ -916,7 +916,7 @@ gdk_event_get_time (const GdkEvent *event) * in the event. @event may be %NULL, in which case it’s treated * as if the event had no state field. * - * Return value: %TRUE if there was a state field in the event + * Returns: %TRUE if there was a state field in the event **/ gboolean gdk_event_get_state (const GdkEvent *event, @@ -997,7 +997,7 @@ gdk_event_get_state (const GdkEvent *event, * * Extract the event window relative x/y coordinates from an event. * - * Return value: %TRUE if the event delivered event window coordinates + * Returns: %TRUE if the event delivered event window coordinates **/ gboolean gdk_event_get_coords (const GdkEvent *event, @@ -1063,7 +1063,7 @@ gdk_event_get_coords (const GdkEvent *event, * * Extract the root window relative x/y coordinates from an event. * - * Return value: %TRUE if the event delivered root window coordinates + * Returns: %TRUE if the event delivered root window coordinates **/ gboolean gdk_event_get_root_coords (const GdkEvent *event, @@ -1133,7 +1133,7 @@ gdk_event_get_root_coords (const GdkEvent *event, * * Extract the button number from an event. * - * Return value: %TRUE if the event delivered a button number + * Returns: %TRUE if the event delivered a button number * * Since: 3.2 **/ @@ -1172,7 +1172,7 @@ gdk_event_get_button (const GdkEvent *event, * * Extracts the click count from an event. * - * Return value: %TRUE if the event delivered a click count + * Returns: %TRUE if the event delivered a click count * * Since: 3.2 */ @@ -1215,7 +1215,7 @@ gdk_event_get_click_count (const GdkEvent *event, * * Extracts the keyval from an event. * - * Return value: %TRUE if the event delivered a key symbol + * Returns: %TRUE if the event delivered a key symbol * * Since: 3.2 */ @@ -1250,7 +1250,7 @@ gdk_event_get_keyval (const GdkEvent *event, * * Extracts the hardware keycode from an event. * - * Return value: %TRUE if the event delivered a hardware keycode + * Returns: %TRUE if the event delivered a hardware keycode * * Since: 3.2 */ @@ -1285,7 +1285,7 @@ gdk_event_get_keycode (const GdkEvent *event, * * Extracts the scroll direction from an event. * - * Return value: %TRUE if the event delivered a scroll direction + * Returns: %TRUE if the event delivered a scroll direction * * Since: 3.2 */ @@ -1370,7 +1370,7 @@ gdk_event_get_scroll_deltas (const GdkEvent *event, * Extract the axis value for a particular axis use from * an event structure. * - * Return value: %TRUE if the specified axis was found, otherwise %FALSE + * Returns: %TRUE if the specified axis was found, otherwise %FALSE **/ gboolean gdk_event_get_axis (const GdkEvent *event, @@ -1921,7 +1921,7 @@ gdk_event_set_screen (GdkEvent *event, * to which `event->motion.x_root` and * `event->motion.y_root` are relative. * - * Return value: (transfer none): the screen for the event + * Returns: (transfer none): the screen for the event * * Since: 2.2 **/ @@ -1992,7 +1992,7 @@ gdk_set_show_events (gboolean show_events) * * Gets whether event debugging output is enabled. * - * Return value: %TRUE if event debugging output is enabled. + * Returns: %TRUE if event debugging output is enabled. **/ gboolean gdk_get_show_events (void) @@ -2225,7 +2225,7 @@ gdk_setting_get (const gchar *name, * * Retrieves the type of the event. * - * Return value: a #GdkEventType + * Returns: a #GdkEventType * * Since: 3.10 */ diff --git a/gdk/gdkframeclock.c b/gdk/gdkframeclock.c index 6a76cfa1aa..3a7bb24145 100644 --- a/gdk/gdkframeclock.c +++ b/gdk/gdkframeclock.c @@ -259,7 +259,7 @@ gdk_frame_clock_init (GdkFrameClock *clock) * time. * * Since: 3.8 - * Return value: a timestamp in microseconds, in the timescale of + * Returns: a timestamp in microseconds, in the timescale of * of g_get_monotonic_time(). */ gint64 @@ -387,7 +387,7 @@ gdk_frame_clock_get_frame_counter (GdkFrameClock *frame_clock) * gdk_frame_clock_get_history_start() and * gdk_frame_clock_get_frame_counter(), inclusive. * - * Return value: the frame counter value for the oldest frame + * Returns: the frame counter value for the oldest frame * that is available in the internal frame history of the * #GdkFrameClock. * Since: 3.8 @@ -436,7 +436,7 @@ _gdk_frame_clock_begin_frame (GdkFrameClock *frame_clock) * for the current frame or a recent frame. The #GdkFrameTimings * object may not yet be complete: see gdk_frame_timings_get_complete(). * - * Return value: the #GdkFrameTimings object for the specified + * Returns: the #GdkFrameTimings object for the specified * frame, or %NULL if it is not available. See * gdk_frame_clock_get_history_start(). * Since: 3.8 diff --git a/gdk/gdkkeys.c b/gdk/gdkkeys.c index 89d6142d6a..85c900d202 100644 --- a/gdk/gdkkeys.c +++ b/gdk/gdkkeys.c @@ -398,7 +398,7 @@ gdk_keymap_get_modifier_state (GdkKeymap *keymap) * The returned array should be freed * with g_free(). * - * Return value: %TRUE if keys were found and returned + * Returns: %TRUE if keys were found and returned **/ gboolean gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap, @@ -459,7 +459,7 @@ gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap, * this function, since the effective group/level may not be * the same as the current keyboard state. * - * Return value: a keyval, or 0 if none was mapped to the given @key + * Returns: a keyval, or 0 if none was mapped to the given @key **/ guint gdk_keymap_lookup_key (GdkKeymap *keymap, @@ -532,7 +532,7 @@ gdk_keymap_lookup_key (GdkKeymap *keymap, * you store accelerators, you should always store them with consumed * modifiers removed. Store `<Control>plus`, not `<Control><Shift>plus`, * - * Return value: %TRUE if there was a keyval bound to the keycode/state/group + * Returns: %TRUE if there was a keyval bound to the keycode/state/group **/ gboolean gdk_keymap_translate_keyboard_state (GdkKeymap *keymap, @@ -680,7 +680,7 @@ gdk_keymap_get_modifier_mask (GdkKeymap *keymap, * `gdk/gdkkeysyms.h` header file * but without the leading “GDK_KEY_”. * - * Return value: (transfer none): a string containing the name of the key, + * Returns: (transfer none): a string containing the name of the key, * or %NULL if @keyval is not a valid key. The string should not be * modified. */ diff --git a/gdk/gdkkeyuni.c b/gdk/gdkkeyuni.c index a8c1c3472b..d770737ccc 100644 --- a/gdk/gdkkeyuni.c +++ b/gdk/gdkkeyuni.c @@ -879,7 +879,7 @@ static const struct { * Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) * character. * - * Return value: the corresponding unicode character, or 0 if there + * Returns: the corresponding unicode character, or 0 if there * is no corresponding character. **/ guint32 @@ -1678,7 +1678,7 @@ static const struct { * * Convert from a ISO10646 character to a key symbol. * - * Return value: the corresponding GDK key symbol, if one exists. + * Returns: the corresponding GDK key symbol, if one exists. * or, if there is no corresponding symbol, * wc | 0x01000000 **/ diff --git a/gdk/gdkpango.c b/gdk/gdkpango.c index 8d9dcdf579..e3fb0c6477 100644 --- a/gdk/gdkpango.c +++ b/gdk/gdkpango.c @@ -212,7 +212,7 @@ layout_iter_get_line_clip_region (PangoLayoutIter *iter, * the clip region. The clip region is mainly useful for highlightling parts * of text, such as when text is selected. * - * Return value: a clip region containing the given ranges + * Returns: a clip region containing the given ranges **/ cairo_region_t* gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line, @@ -256,7 +256,7 @@ gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line, * the clip region. The clip region is mainly useful for highlightling parts * of text, such as when text is selected. * - * Return value: a clip region containing the given ranges + * Returns: a clip region containing the given ranges **/ cairo_region_t* gdk_pango_layout_get_clip_region (PangoLayout *layout, @@ -317,7 +317,7 @@ gdk_pango_layout_get_clip_region (PangoLayout *layout, * is more convenient if you want to keep a context around and track * changes to the screen’s font rendering settings. * - * Return value: (transfer full): a new #PangoContext for the default display + * Returns: (transfer full): a new #PangoContext for the default display **/ PangoContext * gdk_pango_context_get (void) @@ -343,7 +343,7 @@ gdk_pango_context_get (void) * is more convenient if you want to keep a context around and track * changes to the screen’s font rendering settings. * - * Return value: (transfer full): a new #PangoContext for @screen + * Returns: (transfer full): a new #PangoContext for @screen * * Since: 2.2 **/ diff --git a/gdk/gdkpixbuf-drawable.c b/gdk/gdkpixbuf-drawable.c index 640fd2d095..7ad1d27d01 100644 --- a/gdk/gdkpixbuf-drawable.c +++ b/gdk/gdkpixbuf-drawable.c @@ -77,7 +77,7 @@ * (In short, there are several ways this function can fail, and if it fails * it returns %NULL; so check the return value.) * - * Return value: (transfer full): A newly-created pixbuf with a reference + * Returns: (transfer full): A newly-created pixbuf with a reference * count of 1, or %NULL on error */ GdkPixbuf * @@ -225,7 +225,7 @@ convert_no_alpha (guchar *dest_data, * This function will create an RGB pixbuf with 8 bits per channel. * The pixbuf will contain an alpha channel if the @surface contains one. * - * Return value: (transfer full): A newly-created pixbuf with a reference + * Returns: (transfer full): A newly-created pixbuf with a reference * count of 1, or %NULL on error */ GdkPixbuf * diff --git a/gdk/gdkrgba.c b/gdk/gdkrgba.c index 5f65d1574c..66d0bd4039 100644 --- a/gdk/gdkrgba.c +++ b/gdk/gdkrgba.c @@ -281,7 +281,7 @@ gdk_rgba_parse (GdkRGBA *rgba, * A hash function suitable for using for a hash * table that stores #GdkRGBAs. * - * Return value: The hash value for @p + * Returns: The hash value for @p * * Since: 3.0 */ @@ -303,7 +303,7 @@ gdk_rgba_hash (gconstpointer p) * * Compares two RGBA colors. * - * Return value: %TRUE if the two colors compare equal + * Returns: %TRUE if the two colors compare equal * * Since: 3.0 */ diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c index d6ea6ca529..1ae58fa8a5 100644 --- a/gdk/gdkscreen.c +++ b/gdk/gdkscreen.c @@ -336,7 +336,7 @@ gdk_screen_get_monitor_at_window (GdkScreen *screen, * * Returns the width of the default screen in pixels. * - * Return value: the width of the default screen in pixels. + * Returns: the width of the default screen in pixels. **/ gint gdk_screen_width (void) @@ -349,7 +349,7 @@ gdk_screen_width (void) * * Returns the height of the default screen in pixels. * - * Return value: the height of the default screen in pixels. + * Returns: the height of the default screen in pixels. **/ gint gdk_screen_height (void) @@ -363,7 +363,7 @@ gdk_screen_height (void) * Returns the width of the default screen in millimeters. * Note that on many X servers this value will not be correct. * - * Return value: the width of the default screen in millimeters, + * Returns: the width of the default screen in millimeters, * though it is not always correct. **/ gint @@ -378,7 +378,7 @@ gdk_screen_width_mm (void) * Returns the height of the default screen in millimeters. * Note that on many X servers this value will not be correct. * - * Return value: the height of the default screen in millimeters, + * Returns: the height of the default screen in millimeters, * though it is not always correct. **/ gint @@ -427,7 +427,7 @@ gdk_screen_set_font_options (GdkScreen *screen, * * Gets any options previously set with gdk_screen_set_font_options(). * - * Return value: the current font options, or %NULL if no default + * Returns: the current font options, or %NULL if no default * font options have been set. * * Since: 2.10 @@ -477,7 +477,7 @@ gdk_screen_set_resolution (GdkScreen *screen, * Gets the resolution for font handling on the screen; see * gdk_screen_set_resolution() for full details. * - * Return value: the current resolution, or -1 if no resolution + * Returns: the current resolution, or -1 if no resolution * has been set. * * Since: 2.10 @@ -848,7 +848,7 @@ gdk_screen_get_monitor_workarea (GdkScreen *screen, * * Call g_list_free() on the return value when you’re finished with it. * - * Return value: (transfer container) (element-type GdkVisual): + * Returns: (transfer container) (element-type GdkVisual): * a list of visuals; the list must be freed, but not its contents * * Since: 2.2 @@ -869,7 +869,7 @@ gdk_screen_list_visuals (GdkScreen *screen) * This is the visual for the root window of the display. * The return value should not be freed. * - * Return value: (transfer none): the system visual + * Returns: (transfer none): the system visual * * Since: 2.2 **/ @@ -899,7 +899,7 @@ gdk_screen_get_system_visual (GdkScreen * screen) * For setting an overall opacity for a top-level window, see * gdk_window_set_opacity(). * - * Return value: (transfer none): a visual to use for windows with an + * Returns: (transfer none): a visual to use for windows with an * alpha channel or %NULL if the capability is not available. * * Since: 2.8 @@ -923,7 +923,7 @@ gdk_screen_get_rgba_visual (GdkScreen *screen) * On X11 this function returns whether a compositing manager is * compositing @screen. * - * Return value: Whether windows with RGBA visuals can reasonably be + * Returns: Whether windows with RGBA visuals can reasonably be * expected to have their alpha channels drawn correctly on the screen. * * Since: 2.10 @@ -943,7 +943,7 @@ gdk_screen_is_composited (GdkScreen *screen) * Determines the name to pass to gdk_display_open() to get * a #GdkDisplay with this screen as the default screen. * - * Return value: a newly allocated string, free with g_free() + * Returns: a newly allocated string, free with g_free() * * Since: 2.2 **/ @@ -974,7 +974,7 @@ gdk_screen_make_display_name (GdkScreen *screen) * The returned window should be unrefed using g_object_unref() when * no longer needed. * - * Return value: (transfer full): the currently active window, or %NULL. + * Returns: (transfer full): the currently active window, or %NULL. * * Since: 2.10 **/ @@ -1006,7 +1006,7 @@ gdk_screen_get_active_window (GdkScreen *screen) * windows it contains, so it should be freed using g_list_free() and * its windows unrefed using g_object_unref() when no longer needed. * - * Return value: (transfer full) (element-type GdkWindow): + * Returns: (transfer full) (element-type GdkWindow): * a list of #GdkWindows for the current window stack, * or %NULL. * @@ -1063,7 +1063,7 @@ gdk_screen_get_setting (GdkScreen *screen, * where it is better to use gdk_window_get_scale_factor() instead. * * Since: 3.10 - * Return value: the scale factor + * Returns: the scale factor */ gint gdk_screen_get_monitor_scale_factor (GdkScreen *screen, diff --git a/gdk/gdkselection.c b/gdk/gdkselection.c index 1d7c2b6cc4..eab6193e20 100644 --- a/gdk/gdkselection.c +++ b/gdk/gdkselection.c @@ -241,7 +241,7 @@ gdk_selection_send_notify_for_display (GdkDisplay *display, * will not be used by applications, who should use the #GtkClipboard * API instead. * - * Return value: the length of the retrieved data. + * Returns: the length of the retrieved data. */ gint gdk_selection_property_get (GdkWindow *requestor, @@ -289,7 +289,7 @@ gdk_selection_convert (GdkWindow *requestor, * Converts a text property in the given encoding to * a list of UTF-8 strings. * - * Return value: the number of strings in the resulting list + * Returns: the number of strings in the resulting list * * Since: 2.2 */ @@ -318,7 +318,7 @@ gdk_text_property_to_utf8_list_for_display (GdkDisplay *display, * is not specified; it may be as pseudo-escape sequences * \x{ABCD}, or it may be in some other form of approximation. * - * Return value: the newly-allocated string, or %NULL if the + * Returns: the newly-allocated string, or %NULL if the * conversion failed. (It should not fail for * any properly formed UTF-8 string unless system * limits like memory or file descriptors are exceeded.) diff --git a/gdk/gdkvisual.c b/gdk/gdkvisual.c index 77a14fedca..9c27bc0e68 100644 --- a/gdk/gdkvisual.c +++ b/gdk/gdkvisual.c @@ -84,7 +84,7 @@ gdk_visual_class_init (GdkVisualClass *visual_class) * * Call g_list_free() on the return value when you’re finished with it. * - * Return value: (transfer container) (element-type GdkVisual): + * Returns: (transfer container) (element-type GdkVisual): * a list of visuals; the list must be freed, but not its contents */ GList* @@ -100,7 +100,7 @@ gdk_list_visuals (void) * This is the visual for the root window of the display. * The return value should not be freed. * - * Return value: (transfer none): system visual + * Returns: (transfer none): system visual */ GdkVisual* gdk_visual_get_system (void) @@ -115,7 +115,7 @@ gdk_visual_get_system (void) * means “largest,” i.e. 32 preferred over 24 preferred over 8 bits * per pixel. * - * Return value: best available depth + * Returns: best available depth */ gint gdk_visual_get_best_depth (void) @@ -130,7 +130,7 @@ gdk_visual_get_best_depth (void) * * Return the best available visual type for the default GDK screen. * - * Return value: best visual type + * Returns: best visual type */ GdkVisualType gdk_visual_get_best_type (void) @@ -146,7 +146,7 @@ gdk_visual_get_best_type (void) * Get the visual with the most available colors for the default * GDK screen. The return value should not be freed. * - * Return value: (transfer none): best visual + * Returns: (transfer none): best visual */ GdkVisual* gdk_visual_get_best (void) @@ -165,7 +165,7 @@ gdk_visual_get_best (void) * over grayscale or fixed-colormap visuals. The return value should * not be freed. %NULL may be returned if no visual supports @depth. * - * Return value: (transfer none): best visual for the given depth + * Returns: (transfer none): best visual for the given depth */ GdkVisual* gdk_visual_get_best_with_depth (gint depth) @@ -184,7 +184,7 @@ gdk_visual_get_best_with_depth (gint depth) * should not be freed. %NULL may be returned if no visual has type * @visual_type. * - * Return value: (transfer none): best visual of the given type + * Returns: (transfer none): best visual of the given type */ GdkVisual* gdk_visual_get_best_with_type (GdkVisualType visual_type) @@ -203,7 +203,7 @@ gdk_visual_get_best_with_type (GdkVisualType visual_type) * Combines gdk_visual_get_best_with_depth() and * gdk_visual_get_best_with_type(). * - * Return value: (transfer none): best visual with both @depth and + * Returns: (transfer none): best visual with both @depth and * @visual_type, or %NULL if none */ GdkVisual* @@ -265,7 +265,7 @@ gdk_query_visual_types (GdkVisualType **visual_types, * * Returns the type of visual this is (PseudoColor, TrueColor, etc). * - * Return value: A #GdkVisualType stating the type of @visual. + * Returns: A #GdkVisualType stating the type of @visual. * * Since: 2.22 */ @@ -283,7 +283,7 @@ gdk_visual_get_visual_type (GdkVisual *visual) * * Returns the bit depth of this visual. * - * Return value: The bit depth of this visual. + * Returns: The bit depth of this visual. * * Since: 2.22 */ @@ -301,7 +301,7 @@ gdk_visual_get_depth (GdkVisual *visual) * * Returns the byte order of this visual. * - * Return value: A #GdkByteOrder stating the byte order of @visual. + * Returns: A #GdkByteOrder stating the byte order of @visual. * * Since: 2.22 */ @@ -319,7 +319,7 @@ gdk_visual_get_byte_order (GdkVisual *visual) * * Returns the size of a colormap for this visual. * - * Return value: The size of a colormap that is suitable for @visual. + * Returns: The size of a colormap that is suitable for @visual. * * Since: 2.22 */ @@ -337,7 +337,7 @@ gdk_visual_get_colormap_size (GdkVisual *visual) * * Returns the number of significant bits per red, green and blue value. * - * Return value: The number of significant bits per color value for @visual. + * Returns: The number of significant bits per color value for @visual. * * Since: 2.22 */ @@ -454,7 +454,7 @@ gdk_visual_get_blue_pixel_details (GdkVisual *visual, * * Gets the screen to which this visual belongs * - * Return value: (transfer none): the screen to which this visual belongs. + * Returns: (transfer none): the screen to which this visual belongs. * * Since: 2.2 */ diff --git a/gdk/gdkwindow.c b/gdk/gdkwindow.c index 51fc8ba689..606c45c705 100644 --- a/gdk/gdkwindow.c +++ b/gdk/gdkwindow.c @@ -1223,7 +1223,7 @@ sync_native_window_stack_position (GdkWindow *window) * more details. Note: to use this on displays other than the default * display, @parent must be specified. * - * Return value: (transfer full): the new #GdkWindow + * Returns: (transfer full): the new #GdkWindow **/ GdkWindow* gdk_window_new (GdkWindow *parent, @@ -2105,7 +2105,7 @@ gdk_window_get_user_data (GdkWindow *window, * * Gets the type of the window. See #GdkWindowType. * - * Return value: type of window + * Returns: type of window **/ GdkWindowType gdk_window_get_window_type (GdkWindow *window) @@ -2121,7 +2121,7 @@ gdk_window_get_window_type (GdkWindow *window) * * Gets the #GdkVisual describing the pixel format of @window. * - * Return value: (transfer none): a #GdkVisual + * Returns: (transfer none): a #GdkVisual * * Since: 2.24 **/ @@ -2139,7 +2139,7 @@ gdk_window_get_visual (GdkWindow *window) * * Gets the #GdkScreen associated with a #GdkWindow. * - * Return value: (transfer none): the #GdkScreen associated with @window + * Returns: (transfer none): the #GdkScreen associated with @window * * Since: 2.24 **/ @@ -2157,7 +2157,7 @@ gdk_window_get_screen (GdkWindow *window) * * Gets the #GdkDisplay associated with a #GdkWindow. * - * Return value: (transfer none): the #GdkDisplay associated with @window + * Returns: (transfer none): the #GdkDisplay associated with @window * * Since: 2.24 **/ @@ -2174,7 +2174,7 @@ gdk_window_get_display (GdkWindow *window) * * Check to see if a window is destroyed.. * - * Return value: %TRUE if the window is destroyed + * Returns: %TRUE if the window is destroyed * * Since: 2.18 **/ @@ -2271,7 +2271,7 @@ gdk_window_get_position (GdkWindow *window, * gdk_window_get_parent() will most likely not do what you expect if * there are offscreen windows in the hierarchy. * - * Return value: (transfer none): parent of @window + * Returns: (transfer none): parent of @window **/ GdkWindow* gdk_window_get_parent (GdkWindow *window) @@ -2291,7 +2291,7 @@ gdk_window_get_parent (GdkWindow *window) * * See also: gdk_offscreen_window_get_embedder() * - * Return value: (transfer none): effective parent of @window + * Returns: (transfer none): effective parent of @window * * Since: 2.22 **/ @@ -2321,7 +2321,7 @@ gdk_window_get_effective_parent (GdkWindow *window) * gdk_window_get_toplevel() will most likely not do what you expect * if there are offscreen windows in the hierarchy. * - * Return value: (transfer none): the toplevel window containing @window + * Returns: (transfer none): the toplevel window containing @window **/ GdkWindow * gdk_window_get_toplevel (GdkWindow *window) @@ -2349,7 +2349,7 @@ gdk_window_get_toplevel (GdkWindow *window) * * See also: gdk_offscreen_window_get_embedder() * - * Return value: (transfer none): the effective toplevel window containing @window + * Returns: (transfer none): the effective toplevel window containing @window * * Since: 2.22 **/ @@ -2379,7 +2379,7 @@ gdk_window_get_effective_toplevel (GdkWindow *window) * The returned list must be freed, but the elements in the * list need not be. * - * Return value: (transfer container) (element-type GdkWindow): + * Returns: (transfer container) (element-type GdkWindow): * list of child windows inside @window **/ GList* @@ -2400,7 +2400,7 @@ gdk_window_get_children (GdkWindow *window) * Like gdk_window_get_children(), but does not copy the list of * children, so the list does not need to be freed. * - * Return value: (transfer none) (element-type GdkWindow): + * Returns: (transfer none) (element-type GdkWindow): * a reference to the list of child windows in @window **/ GList * @@ -2429,7 +2429,7 @@ gdk_window_peek_children (GdkWindow *window) * The list is returned in (relative) stacking order, i.e. the * lowest window is first. * - * Return value: (transfer container) (element-type GdkWindow): + * Returns: (transfer container) (element-type GdkWindow): * list of child windows inside @window * * Since: 3.10 @@ -2571,7 +2571,7 @@ gdk_window_remove_filter (GdkWindow *window, * The returned list should be freed with g_list_free(), but * its elements need not be freed. * - * Return value: (transfer container) (element-type GdkWindow): + * Returns: (transfer container) (element-type GdkWindow): * list of toplevel windows, free with g_list_free() * * Since: 2.2 @@ -2607,7 +2607,7 @@ gdk_screen_get_toplevel_windows (GdkScreen *screen) * Checks whether the window has been mapped (with gdk_window_show() or * gdk_window_show_unraised()). * - * Return value: %TRUE if the window is mapped + * Returns: %TRUE if the window is mapped **/ gboolean gdk_window_is_visible (GdkWindow *window) @@ -2626,7 +2626,7 @@ gdk_window_is_visible (GdkWindow *window) * we only check as far as we have GDK window parents, not to the root * window.) * - * Return value: %TRUE if the window is viewable + * Returns: %TRUE if the window is viewable **/ gboolean gdk_window_is_viewable (GdkWindow *window) @@ -2646,7 +2646,7 @@ gdk_window_is_viewable (GdkWindow *window) * Gets the bitwise OR of the currently active window state flags, * from the #GdkWindowState enumeration. * - * Return value: window state bitfield + * Returns: window state bitfield **/ GdkWindowState gdk_window_get_state (GdkWindow *window) @@ -3155,7 +3155,7 @@ _gdk_window_ref_cairo_surface (GdkWindow *window) * Note that calling cairo_reset_clip() on the resulting #cairo_t will * produce undefined results, so avoid it at all costs. * - * Return value: A newly created Cairo context. Free with + * Returns: A newly created Cairo context. Free with * cairo_destroy() when you are done drawing. * * Since: 2.8 @@ -4070,7 +4070,7 @@ _gdk_window_invalidate_for_expose (GdkWindow *window, * gdk_window_get_update_area() returns %NULL. You are responsible for * calling cairo_region_destroy() on the returned region if it’s non-%NULL. * - * Return value: the update area for @window + * Returns: the update area for @window **/ cairo_region_t * gdk_window_get_update_area (GdkWindow *window) @@ -4412,7 +4412,7 @@ gdk_window_constrain_size (GdkGeometry *geometry, * The position is given in coordinates relative to the upper left * corner of @window. * - * Return value: (transfer none): the window containing the pointer (as with + * Returns: (transfer none): the window containing the pointer (as with * gdk_window_at_pointer()), or %NULL if the window containing the * pointer isn’t known to GDK * @@ -4445,7 +4445,7 @@ gdk_window_get_pointer (GdkWindow *window, * The position is given in coordinates relative to the upper left * corner of @window. * - * Return value: (transfer none): The window underneath @device (as with + * Returns: (transfer none): The window underneath @device (as with * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK. * * Since: 3.10 @@ -4501,7 +4501,7 @@ gdk_window_get_device_position_double (GdkWindow *window, * * Use gdk_window_get_device_position_double() if you need subpixel precision. * - * Return value: (transfer none): The window underneath @device (as with + * Returns: (transfer none): The window underneath @device (as with * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK. * * Since: 3.0 @@ -4531,7 +4531,7 @@ gdk_window_get_device_position (GdkWindow *window, * Obtains the root window (parent all other windows are inside) * for the default display and screen. * - * Return value: (transfer none): the default root window + * Returns: (transfer none): the default root window **/ GdkWindow * gdk_get_default_root_window (void) @@ -5257,7 +5257,7 @@ gdk_window_set_events (GdkWindow *window, * Gets the event mask for @window for all master input devices. See * gdk_window_set_events(). * - * Return value: event mask for @window + * Returns: event mask for @window **/ GdkEventMask gdk_window_get_events (GdkWindow *window) @@ -5860,7 +5860,7 @@ gdk_window_set_cursor_internal (GdkWindow *window, * there is no custom cursor set on the specified window, and it is * using the cursor for its parent window. * - * Return value: (transfer none): a #GdkCursor, or %NULL. The returned + * 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 @@ -6128,7 +6128,7 @@ gdk_window_get_height (GdkWindow *window) * gdk_window_get_geometry() which return the position of a window * relative to its parent window.) * - * Return value: not meaningful, ignore + * Returns: not meaningful, ignore */ gint gdk_window_get_origin (GdkWindow *window, @@ -6603,7 +6603,7 @@ gdk_window_merge_child_input_shapes (GdkWindow *window) * implementing scary features that involve deep knowledge of the * windowing system. Don’t worry about it unless you have to. * - * Return value: %TRUE if the server supports static gravity + * Returns: %TRUE if the server supports static gravity */ gboolean gdk_window_set_static_gravities (GdkWindow *window, @@ -6717,7 +6717,7 @@ gdk_window_set_composited (GdkWindow *window, * Determines whether or not the window manager is hinted that @window * has modal behaviour. * - * Return value: whether or not the window has the modal hint set. + * Returns: whether or not the window has the modal hint set. * * Since: 2.22 */ @@ -6736,7 +6736,7 @@ gdk_window_get_modal_hint (GdkWindow *window) * Determines whether or not the desktop environment shuld be hinted that * the window does not want to receive input focus. * - * Return value: whether or not the window should receive input focus. + * Returns: whether or not the window should receive input focus. * * Since: 2.22 */ @@ -6755,7 +6755,7 @@ gdk_window_get_accept_focus (GdkWindow *window) * Determines whether or not the desktop environment should be hinted that the * window does not want to receive input focus when it is mapped. * - * Return value: whether or not the window wants to receive input focus when + * Returns: whether or not the window wants to receive input focus when * it is mapped. * * Since: 2.22 @@ -6774,7 +6774,7 @@ gdk_window_get_focus_on_map (GdkWindow *window) * * Determines whether or not the window is an input only window. * - * Return value: %TRUE if @window is input only + * Returns: %TRUE if @window is input only * * Since: 2.22 */ @@ -6792,7 +6792,7 @@ gdk_window_is_input_only (GdkWindow *window) * * Determines whether or not the window is shaped. * - * Return value: %TRUE if @window is shaped + * Returns: %TRUE if @window is shaped * * Since: 2.22 */ @@ -9413,7 +9413,7 @@ gdk_window_set_type_hint (GdkWindow *window, * * This function returns the type hint set for a window. * - * Return value: The type hint set for @window + * Returns: The type hint set for @window * * Since: 2.10 **/ @@ -9755,7 +9755,7 @@ gdk_window_set_event_compression (GdkWindow *window, * * Get the current event compression setting for this window. * - * Return value: %TRUE if motion events will be compressed + * Returns: %TRUE if motion events will be compressed * * Since: 3.12 **/ @@ -10090,7 +10090,7 @@ gdk_window_set_keep_below (GdkWindow *window, gboolean setting) * * Returns the group leader window for @window. See gdk_window_set_group(). * - * Return value: (transfer none): the group leader window for @window + * Returns: (transfer none): the group leader window for @window * * Since: 2.4 **/ @@ -10444,7 +10444,7 @@ gdk_window_get_drag_protocol (GdkWindow *window, * * This function is called by the drag source. * - * Return value: (transfer full): a newly created #GdkDragContext + * Returns: (transfer full): a newly created #GdkDragContext */ GdkDragContext * gdk_drag_begin (GdkWindow *window, @@ -10470,7 +10470,7 @@ gdk_drag_begin (GdkWindow *window, * * This function is called by the drag source. * - * Return value: (transfer full): a newly created #GdkDragContext + * Returns: (transfer full): a newly created #GdkDragContext */ GdkDragContext * gdk_drag_begin_for_device (GdkWindow *window, @@ -10789,7 +10789,7 @@ gdk_window_set_frame_clock (GdkWindow *window, * window. * * Since: 3.8 - * Return value: (transfer none): the frame clock + * Returns: (transfer none): the frame clock */ GdkFrameClock* gdk_window_get_frame_clock (GdkWindow *window) @@ -10821,7 +10821,7 @@ gdk_window_get_frame_clock (GdkWindow *window) * a configure event will be sent to the toplevel window. * * Since: 3.10 - * Return value: the scale factor + * Returns: the scale factor */ gint gdk_window_get_scale_factor (GdkWindow *window) diff --git a/gdk/quartz/gdkeventloop-quartz.c b/gdk/quartz/gdkeventloop-quartz.c index 7ef4f2a46a..89d9e1ee36 100644 --- a/gdk/quartz/gdkeventloop-quartz.c +++ b/gdk/quartz/gdkeventloop-quartz.c @@ -386,7 +386,7 @@ pollfds_equal (GPollFD *old_pollfds, * timeout is used only to tell if the polling operation is blocking * or non-blocking. * - * Return value: + * Returns: * -1: No file descriptors ready, began asynchronous poll * 0: No file descriptors ready, asynchronous poll not needed * > 0: Number of file descriptors ready @@ -543,7 +543,7 @@ select_thread_start_poll (GPollFD *ufds, * * The results of the poll are written into the GPollFD array passed in. * - * Return Value: number of file descriptors ready + * Returns: number of file descriptors ready */ static int select_thread_collect_poll (GPollFD *ufds, guint nfds) diff --git a/gdk/win32/gdkwindow-win32.c b/gdk/win32/gdkwindow-win32.c index bf32dbe73e..18e35cddb2 100644 --- a/gdk/win32/gdkwindow-win32.c +++ b/gdk/win32/gdkwindow-win32.c @@ -3320,7 +3320,7 @@ gdk_win32_window_is_win32 (GdkWindow *window) * * Gets a DC with the given drawable selected into it. * - * Return value: The DC, on success. Otherwise + * Returns: The DC, on success. Otherwise * %NULL. If this function succeeded * _gdk_win32_impl_release_dc() must be called * release the DC when you are done using it. diff --git a/gdk/x11/gdkcursor-x11.c b/gdk/x11/gdkcursor-x11.c index b12a80d10f..43ae9fc695 100644 --- a/gdk/x11/gdkcursor-x11.c +++ b/gdk/x11/gdkcursor-x11.c @@ -291,7 +291,7 @@ _gdk_x11_display_get_cursor_for_type (GdkDisplay *display, * * Returns the display of a #GdkCursor. * - * Return value: (transfer none): an Xlib Display*. + * Returns: (transfer none): an Xlib Display*. **/ Display * gdk_x11_cursor_get_xdisplay (GdkCursor *cursor) @@ -307,7 +307,7 @@ gdk_x11_cursor_get_xdisplay (GdkCursor *cursor) * * Returns the X cursor belonging to a #GdkCursor. * - * Return value: an Xlib Cursor. + * Returns: an Xlib Cursor. **/ Cursor gdk_x11_cursor_get_xcursor (GdkCursor *cursor) diff --git a/gdk/x11/gdkdisplay-x11.c b/gdk/x11/gdkdisplay-x11.c index 1465930069..0953fcf032 100644 --- a/gdk/x11/gdkdisplay-x11.c +++ b/gdk/x11/gdkdisplay-x11.c @@ -1950,7 +1950,7 @@ gdk_x11_display_finalize (GObject *object) * * Find the #GdkDisplay corresponding to @xdisplay, if any exists. * - * Return value: (transfer none) (type GdkX11Display): the #GdkDisplay, if found, otherwise %NULL. + * Returns: (transfer none) (type GdkX11Display): the #GdkDisplay, if found, otherwise %NULL. * * Since: 2.2 **/ @@ -1986,7 +1986,7 @@ 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: (transfer none): the #GdkScreen corresponding to + * Returns: (transfer none): the #GdkScreen corresponding to * @xrootwin, or %NULL. **/ GdkScreen * @@ -2751,7 +2751,7 @@ gdk_x11_display_set_window_scale (GdkDisplay *display, * * Since: 3.0 * - * Return value: X error code or 0 on success + * Returns: X error code or 0 on success */ gint gdk_x11_display_error_trap_pop (GdkDisplay *display) diff --git a/gdk/x11/gdkmain-x11.c b/gdk/x11/gdkmain-x11.c index 9d28b16c82..22c7b95519 100644 --- a/gdk/x11/gdkmain-x11.c +++ b/gdk/x11/gdkmain-x11.c @@ -422,7 +422,7 @@ gdk_x11_ungrab_server (void) * * Gets the default GTK+ screen number. * - * Return value: returns the screen number specified by + * Returns: returns the screen number specified by * the --display command line option or the DISPLAY environment * variable when gdk_init() calls XOpenDisplay(). **/ @@ -438,7 +438,7 @@ gdk_x11_get_default_screen (void) * Gets the root window of the default screen * (see gdk_x11_get_default_screen()). * - * Return value: an Xlib Window. + * Returns: an Xlib Window. **/ Window gdk_x11_get_default_root_xwindow (void) @@ -451,7 +451,7 @@ gdk_x11_get_default_root_xwindow (void) * * Gets the default GTK+ display. * - * Return value: (transfer none): the Xlib Display* for + * Returns: (transfer none): the Xlib Display* for * the display specified in the `--display` command * line option or the `DISPLAY` environment variable. **/ diff --git a/gdk/x11/gdkproperty-x11.c b/gdk/x11/gdkproperty-x11.c index 01f9e3bc3b..00bf0984b4 100644 --- a/gdk/x11/gdkproperty-x11.c +++ b/gdk/x11/gdkproperty-x11.c @@ -175,7 +175,7 @@ lookup_cached_xatom (GdkDisplay *display, * with the same string value. The special value %GDK_NONE * is converted to %None. * - * Return value: the X atom corresponding to @atom, or %None + * Returns: the X atom corresponding to @atom, or %None * * Since: 2.2 **/ @@ -254,7 +254,7 @@ _gdk_x11_precache_atoms (GdkDisplay *display, * Converts from a #GdkAtom to the X atom for the default GDK display * with the same string value. * - * Return value: the X atom corresponding to @atom. + * Returns: the X atom corresponding to @atom. **/ Atom gdk_x11_atom_to_xatom (GdkAtom atom) @@ -270,7 +270,7 @@ gdk_x11_atom_to_xatom (GdkAtom atom) * Convert from an X atom for a #GdkDisplay to the corresponding * #GdkAtom. * - * Return value: (transfer none): the corresponding #GdkAtom. + * Returns: (transfer none): the corresponding #GdkAtom. * * Since: 2.2 **/ @@ -329,7 +329,7 @@ gdk_x11_xatom_to_atom_for_display (GdkDisplay *display, * Convert from an X atom for the default display to the corresponding * #GdkAtom. * - * Return value: (transfer none): the corresponding G#dkAtom. + * Returns: (transfer none): the corresponding G#dkAtom. **/ GdkAtom gdk_x11_xatom_to_atom (Atom xatom) @@ -346,7 +346,7 @@ gdk_x11_xatom_to_atom (Atom xatom) * This function caches the result, so if called repeatedly it is much * faster than XInternAtom(), which is a round trip to the server each time. * - * Return value: a X atom for a #GdkDisplay + * Returns: a X atom for a #GdkDisplay * * Since: 2.2 **/ @@ -387,7 +387,7 @@ _gdk_x11_get_xatom_for_display_printf (GdkDisplay *display, * This function caches the result, so if called repeatedly it is much * faster than XInternAtom(), which is a round trip to the server each time. * - * Return value: a X atom for GDK’s default display. + * Returns: a X atom for GDK’s default display. **/ Atom gdk_x11_get_xatom_by_name (const gchar *atom_name) @@ -406,7 +406,7 @@ gdk_x11_get_xatom_by_name (const gchar *atom_name) * XAtomName() and gdk_atom_name(), the result doesn’t need to * be freed. * - * Return value: name of the X atom; this string is owned by GDK, + * Returns: name of the X atom; this string is owned by GDK, * so it shouldn’t be modifed or freed. * * Since: 2.2 @@ -430,7 +430,7 @@ gdk_x11_get_xatom_name_for_display (GdkDisplay *display, * doesn’t need to be freed. Also, this function will never return %NULL, * even if @xatom is invalid. * - * Return value: name of the X atom; this string is owned by GTK+, + * Returns: name of the X atom; this string is owned by GTK+, * so it shouldn’t be modifed or freed. **/ const gchar * diff --git a/gdk/x11/gdkscreen-x11.c b/gdk/x11/gdkscreen-x11.c index 3bab765f7f..c9c2d81ee5 100644 --- a/gdk/x11/gdkscreen-x11.c +++ b/gdk/x11/gdkscreen-x11.c @@ -1554,7 +1554,7 @@ fetch_net_wm_check_window (GdkScreen *screen) * You can monitor the window_manager_changed signal on #GdkScreen to detect * a window manager change. * - * Return value: %TRUE if the window manager supports @property + * Returns: %TRUE if the window manager supports @property * * Since: 2.2 **/ @@ -1635,7 +1635,7 @@ gdk_x11_screen_supports_net_wm_hint (GdkScreen *screen, * * Returns the name of the window manager for @screen. * - * Return value: the name of the window manager screen @screen, or + * Returns: the name of the window manager screen @screen, or * "unknown" if the window manager is unknown. The string is owned by GDK * and should not be freed. * diff --git a/gdk/x11/gdkselection-x11.c b/gdk/x11/gdkselection-x11.c index b8a682eeaa..b84be26664 100644 --- a/gdk/x11/gdkselection-x11.c +++ b/gdk/x11/gdkselection-x11.c @@ -703,7 +703,7 @@ _gdk_x11_display_utf8_to_string_target (GdkDisplay *display, * * Converts from UTF-8 to compound text. * - * Return value: %TRUE if the conversion succeeded, + * Returns: %TRUE if the conversion succeeded, * otherwise %FALSE * * Since: 2.24 diff --git a/gdk/x11/gdkvisual-x11.c b/gdk/x11/gdkvisual-x11.c index 865f67c439..a88882fe73 100644 --- a/gdk/x11/gdkvisual-x11.c +++ b/gdk/x11/gdkvisual-x11.c @@ -583,7 +583,7 @@ _gdk_visual_get_x11_colormap (GdkVisual *visual) * * Returns the X visual belonging to a #GdkVisual. * - * Return value: (transfer none): an Xlib Visual*. + * Returns: (transfer none): an Xlib Visual*. **/ Visual * gdk_x11_visual_get_xvisual (GdkVisual *visual) diff --git a/gdk/x11/gdkwindow-x11.c b/gdk/x11/gdkwindow-x11.c index 796c082f14..c9328133c1 100644 --- a/gdk/x11/gdkwindow-x11.c +++ b/gdk/x11/gdkwindow-x11.c @@ -1185,7 +1185,7 @@ x_event_mask_to_gdk_event_mask (long mask) * was already known to GDK, a new reference to the existing * #GdkWindow is returned. * - * Return value: (transfer full): a #GdkWindow wrapper for the native + * Returns: (transfer full): a #GdkWindow wrapper for the native * window, or %NULL if the window has been destroyed. The wrapper * will be newly created, if one doesn’t exist already. * @@ -5485,7 +5485,7 @@ timestamp_predicate (Display *display, * * Routine to get the current X server time stamp. * - * Return value: the time stamp. + * Returns: the time stamp. **/ guint32 gdk_x11_get_server_time (GdkWindow *window) @@ -5521,7 +5521,7 @@ gdk_x11_get_server_time (GdkWindow *window) * * Returns the X resource (window) belonging to a #GdkWindow. * - * Return value: the ID of @drawable’s X resource. + * Returns: the ID of @drawable’s X resource. **/ XID gdk_x11_window_get_xid (GdkWindow *window) diff --git a/gdk/x11/gdkxid.c b/gdk/x11/gdkxid.c index d3029e4d84..8302e74b4e 100644 --- a/gdk/x11/gdkxid.c +++ b/gdk/x11/gdkxid.c @@ -85,7 +85,7 @@ _gdk_x11_display_remove_window (GdkDisplay *display, * * Looks up the #GdkWindow that wraps the given native window handle. * - * Return value: (transfer none) (type GdkX11Window): the #GdkWindow wrapper for the native + * Returns: (transfer none) (type GdkX11Window): the #GdkWindow wrapper for the native * window, or %NULL if there is none. * * Since: 2.24 |