diff options
author | William Jon McCann <william.jon.mccann@gmail.com> | 2014-02-19 18:49:43 -0500 |
---|---|---|
committer | William Jon McCann <william.jon.mccann@gmail.com> | 2014-02-19 18:56:05 -0500 |
commit | 469d333aa27c67f7d9b2f3923d62fef8519ff2ba (patch) | |
tree | acacd39d222efb5f22738a36115ed946c43f7797 | |
parent | a6084e264de0c1471ba93a20dd74f19c92a8afc6 (diff) | |
download | gtk+-469d333aa27c67f7d9b2f3923d62fef8519ff2ba.tar.gz |
docs: use Returns: consistently
Instead of Return value:
219 files changed, 1612 insertions, 1612 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) * - ![](sb_v_double_arrow.png) #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 diff --git a/gtk/deprecated/gtkaction.c b/gtk/deprecated/gtkaction.c index 859f29ab52..44e7f3c019 100644 --- a/gtk/deprecated/gtkaction.c +++ b/gtk/deprecated/gtkaction.c @@ -621,7 +621,7 @@ gtk_action_buildable_get_name (GtkBuildable *buildable) * See the [UI Definition section][XML-UI] for information on allowed action * names. * - * Return value: a new #GtkAction + * Returns: a new #GtkAction * * Since: 2.4 * @@ -1105,7 +1105,7 @@ _gtk_action_remove_from_proxy_list (GtkAction *action, * Returns the proxy widgets for an action. * See also gtk_activatable_get_related_action(). * - * Return value: (element-type GtkWidget) (transfer none): a #GSList of proxy widgets. The list is owned by GTK+ + * Returns: (element-type GtkWidget) (transfer none): a #GSList of proxy widgets. The list is owned by GTK+ * and must not be modified. * * Since: 2.4 @@ -1126,7 +1126,7 @@ gtk_action_get_proxies (GtkAction *action) * * Returns the name of the action. * - * Return value: the name of the action. The string belongs to GTK+ and should not + * Returns: the name of the action. The string belongs to GTK+ and should not * be freed. * * Since: 2.4 @@ -1147,7 +1147,7 @@ gtk_action_get_name (GtkAction *action) * * Returns whether the action is effectively sensitive. * - * Return value: %TRUE if the action and its associated action group + * Returns: %TRUE if the action and its associated action group * are both sensitive. * * Since: 2.4 @@ -1175,7 +1175,7 @@ gtk_action_is_sensitive (GtkAction *action) * necessarily mean effective sensitivity. See gtk_action_is_sensitive() * for that. * - * Return value: %TRUE if the action itself is sensitive. + * Returns: %TRUE if the action itself is sensitive. * * Since: 2.4 * @@ -1227,7 +1227,7 @@ gtk_action_set_sensitive (GtkAction *action, * * Returns whether the action is effectively visible. * - * Return value: %TRUE if the action and its associated action group + * Returns: %TRUE if the action and its associated action group * are both visible. * * Since: 2.4 @@ -1255,7 +1255,7 @@ gtk_action_is_visible (GtkAction *action) * necessarily mean effective visibility. See gtk_action_is_sensitive() * for that. * - * Return value: %TRUE if the action itself is visible. + * Returns: %TRUE if the action itself is visible. * * Since: 2.4 * @@ -2060,7 +2060,7 @@ gtk_action_disconnect_accelerator (GtkAction *action) * item or the toolbar item it creates, this function returns an * instance of that menu. * - * Return value: (transfer none): the menu item provided by the + * Returns: (transfer none): the menu item provided by the * action, or %NULL. * * Since: 2.12 diff --git a/gtk/deprecated/gtkactiongroup.c b/gtk/deprecated/gtkactiongroup.c index 44bc6d5b22..113b3ee1da 100644 --- a/gtk/deprecated/gtkactiongroup.c +++ b/gtk/deprecated/gtkactiongroup.c @@ -672,7 +672,7 @@ gtk_action_group_get_name (GtkActionGroup *action_group) * they are sensitive (see gtk_action_get_sensitive()) and their group * is sensitive. * - * Return value: %TRUE if the group is sensitive. + * Returns: %TRUE if the group is sensitive. * * Since: 2.4 * @@ -741,7 +741,7 @@ gtk_action_group_set_sensitive (GtkActionGroup *action_group, * they are visible (see gtk_action_get_visible()) and their group * is visible. * - * Return value: %TRUE if the group is visible. + * Returns: %TRUE if the group is visible. * * Since: 2.4 * diff --git a/gtk/deprecated/gtkcolorsel.c b/gtk/deprecated/gtkcolorsel.c index 7a0206807a..b07211c665 100644 --- a/gtk/deprecated/gtkcolorsel.c +++ b/gtk/deprecated/gtkcolorsel.c @@ -2371,7 +2371,7 @@ default_change_palette_func (GdkScreen *screen, * * Creates a new GtkColorSelection. * - * Return value: a new #GtkColorSelection + * Returns: a new #GtkColorSelection */ GtkWidget * gtk_color_selection_new (void) @@ -2404,7 +2404,7 @@ gtk_color_selection_new (void) * * Determines whether the colorsel has an opacity control. * - * Return value: %TRUE if the @colorsel has an opacity control, + * Returns: %TRUE if the @colorsel has an opacity control, * %FALSE if it does't */ gboolean @@ -2464,7 +2464,7 @@ gtk_color_selection_set_has_opacity_control (GtkColorSelection *colorsel, * * Determines whether the color selector has a color palette. * - * Return value: %TRUE if the selector has a palette, %FALSE if it hasn't + * Returns: %TRUE if the selector has a palette, %FALSE if it hasn't */ gboolean gtk_color_selection_get_has_palette (GtkColorSelection *colorsel) @@ -2612,7 +2612,7 @@ gtk_color_selection_get_current_color (GtkColorSelection *colorsel, * * Returns the current alpha value. * - * Return value: an integer between 0 and 65535 + * Returns: an integer between 0 and 65535 */ guint16 gtk_color_selection_get_current_alpha (GtkColorSelection *colorsel) @@ -2721,7 +2721,7 @@ gtk_color_selection_get_previous_color (GtkColorSelection *colorsel, * * Returns the previous alpha value. * - * Return value: an integer between 0 and 65535 + * Returns: an integer between 0 and 65535 */ guint16 gtk_color_selection_get_previous_alpha (GtkColorSelection *colorsel) @@ -2911,7 +2911,7 @@ gtk_color_selection_set_palette_color (GtkColorSelection *colorsel, * * Gets the current state of the @colorsel. * - * Return value: %TRUE if the user is currently dragging + * Returns: %TRUE if the user is currently dragging * a color around, and %FALSE if the selection has stopped */ gboolean @@ -2937,7 +2937,7 @@ gtk_color_selection_is_adjusting (GtkColorSelection *colorsel) * Parses a color palette string; the string is a colon-separated * list of color names readable by gdk_color_parse(). * - * Return value: %TRUE if a palette was successfully parsed + * Returns: %TRUE if a palette was successfully parsed */ gboolean gtk_color_selection_palette_from_string (const gchar *str, @@ -3021,7 +3021,7 @@ gtk_color_selection_palette_from_string (const gchar *str, * * Encodes a palette as a string, useful for persistent storage. * - * Return value: allocated string encoding the palette + * Returns: allocated string encoding the palette */ gchar* gtk_color_selection_palette_to_string (const GdkColor *colors, @@ -3072,7 +3072,7 @@ gtk_color_selection_palette_to_string (const GdkColor *colors, * the #GtkSettings:gtk-color-palette GtkSettings property so all * GtkColorSelection widgets will be modified. * - * Return value: the previous change palette hook (that was replaced) + * Returns: the previous change palette hook (that was replaced) * * Since: 2.2 */ diff --git a/gtk/deprecated/gtkfontsel.c b/gtk/deprecated/gtkfontsel.c index 83e520ca34..d7b5154af9 100644 --- a/gtk/deprecated/gtkfontsel.c +++ b/gtk/deprecated/gtkfontsel.c @@ -603,7 +603,7 @@ gtk_font_selection_init (GtkFontSelection *fontsel) * * Creates a new #GtkFontSelection. * - * Return value: a new #GtkFontSelection + * Returns: a new #GtkFontSelection * * Deprecated: 3.2: Use #GtkFontChooserWidget instead */ @@ -1208,7 +1208,7 @@ gtk_font_selection_update_preview (GtkFontSelection *fontsel) * This returns the #GtkTreeView that lists font families, for * example, “Sans”, “Serif”, etc. * - * Return value: (transfer none): A #GtkWidget that is part of @fontsel + * Returns: (transfer none): A #GtkWidget that is part of @fontsel * * Since: 2.14 * @@ -1229,7 +1229,7 @@ gtk_font_selection_get_family_list (GtkFontSelection *fontsel) * This returns the #GtkTreeView which lists all styles available for * the selected font. For example, “Regular”, “Bold”, etc. * - * Return value: (transfer none): A #GtkWidget that is part of @fontsel + * Returns: (transfer none): A #GtkWidget that is part of @fontsel * * Since: 2.14 * @@ -1250,7 +1250,7 @@ gtk_font_selection_get_face_list (GtkFontSelection *fontsel) * This returns the #GtkEntry used to allow the user to edit the font * number manually instead of selecting it from the list of font sizes. * - * Return value: (transfer none): A #GtkWidget that is part of @fontsel + * Returns: (transfer none): A #GtkWidget that is part of @fontsel * * Since: 2.14 * @@ -1270,7 +1270,7 @@ gtk_font_selection_get_size_entry (GtkFontSelection *fontsel) * * This returns the #GtkTreeView used to list font sizes. * - * Return value: (transfer none): A #GtkWidget that is part of @fontsel + * Returns: (transfer none): A #GtkWidget that is part of @fontsel * * Since: 2.14 * @@ -1290,7 +1290,7 @@ gtk_font_selection_get_size_list (GtkFontSelection *fontsel) * * This returns the #GtkEntry used to display the font as a preview. * - * Return value: (transfer none): A #GtkWidget that is part of @fontsel + * Returns: (transfer none): A #GtkWidget that is part of @fontsel * * Since: 2.14 * @@ -1310,7 +1310,7 @@ gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel) * * Gets the #PangoFontFamily representing the selected font family. * - * Return value: (transfer none): A #PangoFontFamily representing the + * Returns: (transfer none): A #PangoFontFamily representing the * selected font family. Font families are a collection of font * faces. The returned object is owned by @fontsel and must not * be modified or freed. @@ -1334,7 +1334,7 @@ gtk_font_selection_get_family (GtkFontSelection *fontsel) * Gets the #PangoFontFace representing the selected font group * details (i.e. family, slant, weight, width, etc). * - * Return value: (transfer none): A #PangoFontFace representing the + * Returns: (transfer none): A #PangoFontFace representing the * selected font group details. The returned object is owned by * @fontsel and must not be modified or freed. * @@ -1356,7 +1356,7 @@ gtk_font_selection_get_face (GtkFontSelection *fontsel) * * The selected font size. * - * Return value: A n integer representing the selected font size, + * Returns: A n integer representing the selected font size, * or -1 if no font size is selected. * * Since: 2.14 @@ -1384,7 +1384,7 @@ gtk_font_selection_get_size (GtkFontSelection *fontsel) * “Helvetica Bold Italic 12”. Use pango_font_description_equal() * if you want to compare two font descriptions. * - * Return value: A string with the name of the current font, or %NULL if + * Returns: A string with the name of the current font, or %NULL if * no font is selected. You must free this string with g_free(). * * Deprecated: 3.2: Use #GtkFontChooser @@ -1518,7 +1518,7 @@ gtk_font_selection_select_font_desc (GtkFontSelection *fontsel, * for this to work; this can be guaranteed by simply making sure that the * @fontsel is inserted in a toplevel window before you call this function. * - * Return value: %TRUE if the font could be set successfully; %FALSE if no + * Returns: %TRUE if the font could be set successfully; %FALSE if no * such font exists or if the @fontsel doesn’t belong to a particular * screen yet. * @@ -1563,7 +1563,7 @@ gtk_font_selection_set_font_name (GtkFontSelection *fontsel, * * Gets the text displayed in the preview area. * - * Return value: the text displayed in the preview area. + * Returns: the text displayed in the preview area. * This string is owned by the widget and should not be * modified or freed * @@ -1717,7 +1717,7 @@ gtk_font_selection_dialog_init (GtkFontSelectionDialog *fontseldiag) * * Creates a new #GtkFontSelectionDialog. * - * Return value: a new #GtkFontSelectionDialog + * Returns: a new #GtkFontSelectionDialog * * Deprecated: 3.2: Use #GtkFontChooserDialog */ @@ -1761,7 +1761,7 @@ gtk_font_selection_dialog_get_font_selection (GtkFontSelectionDialog *fsd) * * Gets the “OK” button. * - * Return value: (transfer none): the #GtkWidget used in the dialog + * Returns: (transfer none): the #GtkWidget used in the dialog * for the “OK” button. * * Since: 2.14 @@ -1782,7 +1782,7 @@ gtk_font_selection_dialog_get_ok_button (GtkFontSelectionDialog *fsd) * * Gets the “Cancel” button. * - * Return value: (transfer none): the #GtkWidget used in the dialog + * Returns: (transfer none): the #GtkWidget used in the dialog * for the “Cancel” button. * * Since: 2.14 @@ -1838,7 +1838,7 @@ gtk_font_selection_dialog_buildable_get_internal_child (GtkBuildable *buildable, * to “Helvetica Bold Italic 12”. Use pango_font_description_equal() * if you want to compare two font descriptions. * - * Return value: A string with the name of the current font, or %NULL if no + * Returns: A string with the name of the current font, or %NULL if no * font is selected. You must free this string with g_free(). * * Deprecated: 3.2: Use #GtkFontChooserDialog @@ -1862,7 +1862,7 @@ gtk_font_selection_dialog_get_font_name (GtkFontSelectionDialog *fsd) * * Sets the currently selected font. * - * Return value: %TRUE if the font selected in @fsd is now the + * Returns: %TRUE if the font selected in @fsd is now the * @fontname specified, %FALSE otherwise. * * Deprecated: 3.2: Use #GtkFontChooserDialog @@ -1887,7 +1887,7 @@ gtk_font_selection_dialog_set_font_name (GtkFontSelectionDialog *fsd, * * Gets the text displayed in the preview area. * - * Return value: the text displayed in the preview area. + * Returns: the text displayed in the preview area. * This string is owned by the widget and should not be * modified or freed * diff --git a/gtk/deprecated/gtkhandlebox.c b/gtk/deprecated/gtkhandlebox.c index 3987c19106..3fb37c3399 100644 --- a/gtk/deprecated/gtkhandlebox.c +++ b/gtk/deprecated/gtkhandlebox.c @@ -930,7 +930,7 @@ gtk_handle_box_set_shadow_type (GtkHandleBox *handle_box, * Gets the type of shadow drawn around the handle box. See * gtk_handle_box_set_shadow_type(). * - * Return value: the type of shadow currently drawn around the handle box. + * Returns: the type of shadow currently drawn around the handle box. * * Deprecated: 3.4: #GtkHandleBox has been deprecated. **/ @@ -976,7 +976,7 @@ gtk_handle_box_set_handle_position (GtkHandleBox *handle_box, * Gets the handle position of the handle box. See * gtk_handle_box_set_handle_position(). * - * Return value: the current handle position. + * Returns: the current handle position. * * Deprecated: 3.4: #GtkHandleBox has been deprecated. **/ @@ -1039,7 +1039,7 @@ gtk_handle_box_set_snap_edge (GtkHandleBox *handle_box, * Gets the edge used for determining reattachment of the handle box. * See gtk_handle_box_set_snap_edge(). * - * Return value: the edge used for determining reattachment, or + * Returns: the edge used for determining reattachment, or * (GtkPositionType)-1 if this is determined (as per default) * from the handle position. * @@ -1059,7 +1059,7 @@ gtk_handle_box_get_snap_edge (GtkHandleBox *handle_box) * * Whether the handlebox’s child is currently detached. * - * Return value: %TRUE if the child is currently detached, otherwise %FALSE + * Returns: %TRUE if the child is currently detached, otherwise %FALSE * * Since: 2.14 * diff --git a/gtk/deprecated/gtkhscale.c b/gtk/deprecated/gtkhscale.c index 58aa6e8b10..557287488e 100644 --- a/gtk/deprecated/gtkhscale.c +++ b/gtk/deprecated/gtkhscale.c @@ -102,7 +102,7 @@ gtk_hscale_new (GtkAdjustment *adjustment) * is a power of ten. If the resulting precision is not suitable for your * needs, use gtk_scale_set_digits() to correct it. * - * Return value: a new #GtkHScale + * Returns: a new #GtkHScale * * Deprecated: 3.2: Use gtk_scale_new_with_range() with %GTK_ORIENTATION_HORIZONTAL instead **/ diff --git a/gtk/deprecated/gtkhsv.c b/gtk/deprecated/gtkhsv.c index fa5a9b7b59..eb7de5f231 100644 --- a/gtk/deprecated/gtkhsv.c +++ b/gtk/deprecated/gtkhsv.c @@ -1209,7 +1209,7 @@ gtk_hsv_focus (GtkWidget *widget, * * Creates a new HSV color selector. * - * Return value: A newly-created HSV color selector. + * Returns: A newly-created HSV color selector. * * Since: 2.14 */ @@ -1362,7 +1362,7 @@ gtk_hsv_get_metrics (GtkHSV *hsv, * adjusting the value with the mouse. This function queries whether * the HSV color selector is being adjusted or not. * - * Return value: %TRUE if clients can ignore changes to the color value, + * Returns: %TRUE if clients can ignore changes to the color value, * since they may be transitory, or %FALSE if they should consider * the color value status to be final. * diff --git a/gtk/deprecated/gtkiconfactory.c b/gtk/deprecated/gtkiconfactory.c index 4ee94c7541..0bb8d4d87d 100644 --- a/gtk/deprecated/gtkiconfactory.c +++ b/gtk/deprecated/gtkiconfactory.c @@ -265,7 +265,7 @@ gtk_icon_factory_finalize (GObject *object) * add a default icon factory with their icons, which will allow * themes to override the icons for the application. * - * Return value: a new #GtkIconFactory + * Returns: a new #GtkIconFactory * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -336,7 +336,7 @@ gtk_icon_factory_add (GtkIconFactory *factory, * widget that will display the icon, instead of using this * function directly, so that themes are taken into account. * - * Return value: (transfer none): icon set of @stock_id. + * Returns: (transfer none): icon set of @stock_id. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -437,7 +437,7 @@ _gtk_icon_factory_get_default_icons (void) * using this function directly, so that themes are taken into * account. * - * Return value: (transfer none): a #GtkIconSet, or %NULL + * Returns: (transfer none): a #GtkIconSet, or %NULL * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -761,7 +761,7 @@ icon_size_lookup_intern (GtkIconSize size, * are free to render the pixbuf however they like, including changing * the usual size. * - * Return value: %TRUE if @size was a valid size + * Returns: %TRUE if @size was a valid size * * Since: 2.2 * @@ -793,7 +793,7 @@ gtk_icon_size_lookup_for_settings (GtkSettings *settings, * are free to render the pixbuf however they like, including changing * the usual size. * - * Return value: %TRUE if @size was a valid size + * Returns: %TRUE if @size was a valid size */ gboolean gtk_icon_size_lookup (GtkIconSize size, @@ -927,7 +927,7 @@ gtk_icon_size_register_alias (const gchar *alias, * * Looks up the icon size associated with @name. * - * Return value: (type int): the icon size + * Returns: (type int): the icon size * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -1029,7 +1029,7 @@ static guint cache_serial = 0; * #GtkIconSet is to create application-specific icon sets to place in * a #GtkIconFactory. * - * Return value: a new #GtkIconSet + * Returns: a new #GtkIconSet * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -1059,7 +1059,7 @@ gtk_icon_set_new (void) * using scaling, pixelation, etc. as required to adjust the icon size * or make the icon look insensitive/prelighted. * - * Return value: a new #GtkIconSet + * Returns: a new #GtkIconSet * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -1088,7 +1088,7 @@ gtk_icon_set_new_from_pixbuf (GdkPixbuf *pixbuf) * * Increments the reference count on @icon_set. * - * Return value: @icon_set. + * Returns: @icon_set. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -1147,7 +1147,7 @@ G_DEFINE_BOXED_TYPE (GtkIconSet, gtk_icon_set, * * Copies @icon_set by value. * - * Return value: a new #GtkIconSet identical to the first. + * Returns: a new #GtkIconSet identical to the first. * * Deprecated: 3.10: Use #GtkIconTheme instead. **/ @@ -1550,7 +1550,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS; * (perhaps because an image file fails to load), a default "missing * image" icon will be returned instead. * - * Return value: (transfer full): a #GdkPixbuf to be displayed + * Returns: (transfer full): a #GdkPixbuf to be displayed * * Since: 3.0 * @@ -1583,7 +1583,7 @@ gtk_icon_set_render_icon_pixbuf (GtkIconSet *icon_set, * (perhaps because an image file fails to load), a default "missing * image" icon will be returned instead. * - * Return value: (transfer full): a #cairo_surface_t to be displayed + * Returns: (transfer full): a #cairo_surface_t to be displayed * * Since: 3.10 * @@ -1629,7 +1629,7 @@ gtk_icon_set_render_icon_surface (GtkIconSet *icon_set, * (perhaps because an image file fails to load), a default "missing * image" icon will be returned instead. * - * Return value: (transfer full): a #GdkPixbuf to be displayed + * Returns: (transfer full): a #GdkPixbuf to be displayed * * Deprecated: 3.0: Use gtk_icon_set_render_icon_pixbuf() instead */ @@ -1885,7 +1885,7 @@ gtk_icon_set_get_sizes (GtkIconSet *icon_set, * the icon source will be used as the base icon for any desired text * direction, widget state, or icon size. * - * Return value: a new #GtkIconSource + * Returns: a new #GtkIconSource * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -1913,7 +1913,7 @@ gtk_icon_source_new (void) * * Creates a copy of @source; mostly useful for language bindings. * - * Return value: a new #GtkIconSource + * Returns: a new #GtkIconSource * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2101,7 +2101,7 @@ gtk_icon_source_set_pixbuf (GtkIconSource *source, * filename is not a copy, and should not be modified or expected to * persist beyond the lifetime of the icon source. * - * Return value: (type filename): image filename. This string must not + * Returns: (type filename): image filename. This string must not * be modified or freed. * * Deprecated: 3.10: Use #GtkIconTheme instead. @@ -2125,7 +2125,7 @@ gtk_icon_source_get_filename (const GtkIconSource *source) * icon_name is not a copy, and should not be modified or expected to * persist beyond the lifetime of the icon source. * - * Return value: icon name. This string must not be modified or freed. + * Returns: icon name. This string must not be modified or freed. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2153,7 +2153,7 @@ gtk_icon_source_get_icon_name (const GtkIconSource *source) * virtual function. The reference count on the pixbuf is * not incremented. * - * Return value: (transfer none): source pixbuf + * Returns: (transfer none): source pixbuf * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2262,7 +2262,7 @@ gtk_icon_source_set_size_wildcarded (GtkIconSource *source, * * Gets the value set by gtk_icon_source_set_size_wildcarded(). * - * Return value: %TRUE if this icon source is a base for any icon size variant + * Returns: %TRUE if this icon source is a base for any icon size variant * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2280,7 +2280,7 @@ gtk_icon_source_get_size_wildcarded (const GtkIconSource *source) * * Gets the value set by gtk_icon_source_set_state_wildcarded(). * - * Return value: %TRUE if this icon source is a base for any widget state variant + * Returns: %TRUE if this icon source is a base for any widget state variant * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2298,7 +2298,7 @@ gtk_icon_source_get_state_wildcarded (const GtkIconSource *source) * * Gets the value set by gtk_icon_source_set_direction_wildcarded(). * - * Return value: %TRUE if this icon source is a base for any text direction variant + * Returns: %TRUE if this icon source is a base for any text direction variant * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2390,7 +2390,7 @@ gtk_icon_source_set_size (GtkIconSource *source, * value is only useful/meaningful if the text direction is not * wildcarded. * - * Return value: text direction this source matches + * Returns: text direction this source matches * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2410,7 +2410,7 @@ gtk_icon_source_get_direction (const GtkIconSource *source) * value is only useful/meaningful if the widget state is not * wildcarded. * - * Return value: widget state this source matches + * Returns: widget state this source matches * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2429,7 +2429,7 @@ gtk_icon_source_get_state (const GtkIconSource *source) * Obtains the icon size this source applies to. The return value * is only useful/meaningful if the icon size is not wildcarded. * - * Return value: (type int): icon size this source matches. + * Returns: (type int): icon size this source matches. * * Deprecated: 3.10: Use #GtkIconTheme instead. */ @@ -2722,7 +2722,7 @@ _gtk_icon_set_invalidate_caches (void) * The strings in the returned list aren’t copied. * The list itself should be freed. * - * Return value: List of ids in icon factories + * Returns: List of ids in icon factories * * Deprecated: 3.10: Use #GtkIconTheme instead. */ diff --git a/gtk/deprecated/gtkimagemenuitem.c b/gtk/deprecated/gtkimagemenuitem.c index 02545072ba..73debc9d6a 100644 --- a/gtk/deprecated/gtkimagemenuitem.c +++ b/gtk/deprecated/gtkimagemenuitem.c @@ -1109,7 +1109,7 @@ gtk_image_menu_item_set_image (GtkImageMenuItem *image_menu_item, * Gets the widget that is currently set as the image of @image_menu_item. * See gtk_image_menu_item_set_image(). * - * Return value: (transfer none): the widget set as image of @image_menu_item + * Returns: (transfer none): the widget set as image of @image_menu_item * * Deprecated: 3.10 **/ diff --git a/gtk/deprecated/gtkradioaction.c b/gtk/deprecated/gtkradioaction.c index b82a5c3dd3..b4c724e45a 100644 --- a/gtk/deprecated/gtkradioaction.c +++ b/gtk/deprecated/gtkradioaction.c @@ -208,7 +208,7 @@ gtk_radio_action_init (GtkRadioAction *action) * a #GtkActionGroup and set the accelerator for the action, * call gtk_action_group_add_action_with_accel(). * - * Return value: a new #GtkRadioAction + * Returns: a new #GtkRadioAction * * Since: 2.4 * @@ -544,7 +544,7 @@ gtk_radio_action_join_group (GtkRadioAction *action, * Obtains the value property of the currently active member of * the group to which @action belongs. * - * Return value: The value of the currently active group member + * Returns: The value of the currently active group member * * Since: 2.4 * diff --git a/gtk/deprecated/gtkrc.c b/gtk/deprecated/gtkrc.c index 4e7a0b7f5a..7239527194 100644 --- a/gtk/deprecated/gtkrc.c +++ b/gtk/deprecated/gtkrc.c @@ -948,7 +948,7 @@ gtk_rc_set_default_files (gchar **filenames) * Retrieves the current list of RC files that will be parsed * at the end of gtk_init(). * - * Return value: (transfer none) (array zero-terminated=1) (element-type filename): + * Returns: (transfer none) (array zero-terminated=1) (element-type filename): * A %NULL-terminated array of filenames. This memory is owned * by GTK+ and must not be freed by the application. If you want * to store this information, you should make a copy. @@ -1140,7 +1140,7 @@ gtk_rc_style_new (void) * will correctly copy an RC style that is a member of a class * derived from #GtkRcStyle. * - * Return value: (transfer full): the resulting #GtkRcStyle + * Returns: (transfer full): the resulting #GtkRcStyle * * Deprecated: 3.0: Use #GtkCssProvider instead. **/ @@ -1329,7 +1329,7 @@ gtk_rc_reset_styles (GtkSettings *settings) * for the given #GtkSettings has changed, discard all style information * and then reread all previously read RC files. * - * Return value: %TRUE if the files were reread. + * Returns: %TRUE if the files were reread. * * Deprecated: 3.0: Use #GtkCssProvider instead. **/ @@ -1347,7 +1347,7 @@ gtk_rc_reparse_all_for_settings (GtkSettings *settings, * default #GtkSettings has changed, discard all style information * and then reread all previously read RC files. * - * Return value: %TRUE if the files were reread. + * Returns: %TRUE if the files were reread. * * Deprecated: 3.0: Use #GtkCssProvider instead. **/ @@ -1409,7 +1409,7 @@ gtk_rc_get_style (GtkWidget *widget) * G_OBJECT_TYPE (widget)); * ]| * - * Return value: (transfer none): A style created by matching with the + * Returns: (transfer none): A style created by matching with the * supplied paths, or %NULL if nothing matching was specified and the * default style should be used. The returned value is owned by GTK+ * as part of an internal cache, so you must call g_object_ref() on @@ -1553,7 +1553,7 @@ lookup_color (GtkRcStyle *style, * If the file is not found, it outputs a warning message using * g_warning() and returns %NULL. * - * Return value: (type filename): the filename. + * Returns: (type filename): the filename. * * Deprecated: 3.0: Use #GtkCssProvider instead. **/ @@ -1574,7 +1574,7 @@ gtk_rc_find_pixmap_in_path (GtkSettings *settings, * Searches for a theme engine in the GTK+ search path. This function * is not useful for applications and should not be used. * - * Return value: (type filename): The filename, if found (must be + * Returns: (type filename): The filename, if found (must be * freed with g_free()), otherwise %NULL. * * Deprecated: 3.0: Use #GtkCssProvider instead. diff --git a/gtk/deprecated/gtkrecentaction.c b/gtk/deprecated/gtkrecentaction.c index d021e34da6..309140ceb0 100644 --- a/gtk/deprecated/gtkrecentaction.c +++ b/gtk/deprecated/gtkrecentaction.c @@ -688,7 +688,7 @@ gtk_recent_action_init (GtkRecentAction *action) * a #GtkActionGroup and set the accelerator for the action, * call gtk_action_group_add_action_with_accel(). * - * Return value: the newly created #GtkRecentAction. + * Returns: the newly created #GtkRecentAction. * * Since: 2.12 * @@ -725,7 +725,7 @@ gtk_recent_action_new (const gchar *name, * a #GtkActionGroup and set the accelerator for the action, * call gtk_action_group_add_action_with_accel(). * - * Return value: the newly created #GtkRecentAction + * Returns: the newly created #GtkRecentAction * * Since: 2.12 * @@ -756,7 +756,7 @@ gtk_recent_action_new_for_manager (const gchar *name, * * Returns the value set by gtk_recent_chooser_menu_set_show_numbers(). * - * Return value: %TRUE if numbers should be shown. + * Returns: %TRUE if numbers should be shown. * * Since: 2.12 * diff --git a/gtk/deprecated/gtkstock.c b/gtk/deprecated/gtkstock.c index 874dbc7f47..3415f6e24c 100644 --- a/gtk/deprecated/gtkstock.c +++ b/gtk/deprecated/gtkstock.c @@ -181,7 +181,7 @@ gtk_stock_add_static (const GtkStockItem *items, * Fills @item with the registered values for @stock_id, returning %TRUE * if @stock_id was known. * - * Return value: %TRUE if @item was initialized + * Returns: %TRUE if @item was initialized * * Deprecated: 3.10 **/ @@ -229,7 +229,7 @@ gtk_stock_lookup (const gchar *stock_id, * or registered with gtk_stock_add(). The list must be freed with g_slist_free(), * and each string in the list must be freed with g_free(). * - * Return value: (element-type utf8) (transfer full): a list of known stock IDs + * Returns: (element-type utf8) (transfer full): a list of known stock IDs * * Deprecated: 3.10 **/ @@ -281,7 +281,7 @@ gtk_stock_list_ids (void) * * Copies a stock item, mostly useful for language bindings and not in applications. * - * Return value: a new #GtkStockItem + * Returns: a new #GtkStockItem * * Deprecated: 3.10 **/ diff --git a/gtk/deprecated/gtkstyle.c b/gtk/deprecated/gtkstyle.c index ab9464f23e..6b759deea0 100644 --- a/gtk/deprecated/gtkstyle.c +++ b/gtk/deprecated/gtkstyle.c @@ -960,7 +960,7 @@ gtk_style_detach (GtkStyle *style) * and the default icon factory, returning an icon set if found, * otherwise %NULL. * - * Return value: (transfer none): icon set of @stock_id + * Returns: (transfer none): icon set of @stock_id * * Deprecated:3.0: Use gtk_style_context_lookup_icon_set() instead */ @@ -993,7 +993,7 @@ gtk_style_lookup_icon_set (GtkStyle *style, * it depends on the #GtkStyle and might change when a theme * switch occurs. * - * Return value: %TRUE if the mapping was found. + * Returns: %TRUE if the mapping was found. * * Since: 2.10 * @@ -1290,7 +1290,7 @@ gtk_style_real_set_background (GtkStyle *style, * according to the given parameters and returns the result in a * pixbuf. * - * Return value: (transfer full): a newly-created #GdkPixbuf + * Returns: (transfer full): a newly-created #GdkPixbuf * containing the rendered icon * * Deprecated:3.0: Use gtk_render_icon_pixbuf() instead @@ -4160,7 +4160,7 @@ gtk_widget_ensure_style (GtkWidget *widget) * * Simply an accessor function that returns @widget->style. * - * Return value: (transfer none): the widget’s #GtkStyle + * Returns: (transfer none): the widget’s #GtkStyle * * Deprecated:3.0: Use #GtkStyleContext instead */ @@ -4239,7 +4239,7 @@ gtk_widget_modify_style (GtkWidget *widget, * thus dropping any reference to the old modifier style. Add a reference * to the modifier style if you want to keep it alive. * - * Return value: (transfer none): the modifier style for the widget. + * Returns: (transfer none): the modifier style for the widget. * This rc style is owned by the widget. If you want to keep a * pointer to value this around, you must add a refcount using * g_object_ref(). @@ -4749,7 +4749,7 @@ gtk_widget_class_path (GtkWidget *widget, * the application and should not be modified. The pixbuf should be * freed after use with g_object_unref(). * - * Return value: (transfer full): a new pixbuf, or %NULL if the + * Returns: (transfer full): a new pixbuf, or %NULL if the * stock ID wasn’t known * * Deprecated: 3.0: Use gtk_widget_render_icon_pixbuf() instead. diff --git a/gtk/deprecated/gtktable.c b/gtk/deprecated/gtktable.c index 23b98bdaa2..94fa5baa98 100644 --- a/gtk/deprecated/gtktable.c +++ b/gtk/deprecated/gtktable.c @@ -866,7 +866,7 @@ gtk_table_set_row_spacing (GtkTable *table, * Gets the amount of space between row @row, and * row @row + 1. See gtk_table_set_row_spacing(). * - * Return value: the row spacing + * Returns: the row spacing * * Deprecated: 3.4: #GtkGrid does not offer a replacement for this * functionality. @@ -929,7 +929,7 @@ gtk_table_set_col_spacing (GtkTable *table, * Gets the amount of space between column @col, and * column @col + 1. See gtk_table_set_col_spacing(). * - * Return value: the column spacing + * Returns: the column spacing * * Deprecated: 3.4: #GtkGrid does not offer a replacement for this * functionality. @@ -987,7 +987,7 @@ gtk_table_set_row_spacings (GtkTable *table, * the spacing that will be used for newly added rows. * (See gtk_table_set_row_spacings()) * - * Return value: the default row spacing + * Returns: the default row spacing * * Deprecated: 3.4: Use gtk_grid_get_row_spacing() with #GtkGrid. **/ @@ -1038,7 +1038,7 @@ gtk_table_set_col_spacings (GtkTable *table, * the spacing that will be used for newly added columns. * (See gtk_table_set_col_spacings()) * - * Return value: the default column spacing + * Returns: the default column spacing * * Deprecated: 3.4: Use gtk_grid_get_column_spacing() with #GtkGrid. **/ @@ -1091,7 +1091,7 @@ gtk_table_set_homogeneous (GtkTable *table, * Returns whether the table cells are all constrained to the same * width and height. (See gtk_table_set_homogeneous ()) * - * Return value: %TRUE if the cells are all constrained to the same size + * Returns: %TRUE if the cells are all constrained to the same size * * Deprecated: 3.4: Use gtk_grid_get_row_homogeneous() and * gtk_grid_get_column_homogeneous() with #GtkGrid. diff --git a/gtk/deprecated/gtktoggleaction.c b/gtk/deprecated/gtktoggleaction.c index 82ebc91ba1..71bb0367da 100644 --- a/gtk/deprecated/gtktoggleaction.c +++ b/gtk/deprecated/gtktoggleaction.c @@ -178,7 +178,7 @@ gtk_toggle_action_init (GtkToggleAction *action) * a #GtkActionGroup and set the accelerator for the action, * call gtk_action_group_add_action_with_accel(). * - * Return value: a new #GtkToggleAction + * Returns: a new #GtkToggleAction * * Since: 2.4 * diff --git a/gtk/deprecated/gtkuimanager.c b/gtk/deprecated/gtkuimanager.c index 9ae6c785d1..35da0dbc16 100644 --- a/gtk/deprecated/gtkuimanager.c +++ b/gtk/deprecated/gtkuimanager.c @@ -829,7 +829,7 @@ gtk_ui_manager_real_get_action (GtkUIManager *manager, * * Creates a new ui manager object. * - * Return value: a new ui manager object. + * Returns: a new ui manager object. * * Since: 2.4 * @@ -849,7 +849,7 @@ gtk_ui_manager_new (void) * Returns whether menus generated by this #GtkUIManager * will have tearoff menu items. * - * Return value: whether tearoff menu items are added + * Returns: whether tearoff menu items are added * * Since: 2.4 * @@ -1049,7 +1049,7 @@ gtk_ui_manager_remove_action_group (GtkUIManager *manager, * * Returns the list of action groups associated with @manager. * - * Return value: (element-type GtkActionGroup) (transfer none): a #GList of + * Returns: (element-type GtkActionGroup) (transfer none): a #GList of * action groups. The list is owned by GTK+ * and should not be modified. * @@ -1071,7 +1071,7 @@ gtk_ui_manager_get_action_groups (GtkUIManager *manager) * * Returns the #GtkAccelGroup associated with @manager. * - * Return value: (transfer none): the #GtkAccelGroup. + * Returns: (transfer none): the #GtkAccelGroup. * * Since: 2.4 * @@ -1105,7 +1105,7 @@ gtk_ui_manager_get_accel_group (GtkUIManager *manager) * function to some container or explicitly ref them, they will survive the * destruction of the ui manager. * - * Return value: (transfer none): the widget found by following the path, + * Returns: (transfer none): the widget found by following the path, * or %NULL if no widget was found * * Since: 2.4 @@ -1163,7 +1163,7 @@ collect_toplevels (GNode *node, * * Obtains a list of all toplevel widgets of the requested types. * - * Return value: (element-type GtkWidget) (transfer container): a newly-allocated #GSList of + * Returns: (element-type GtkWidget) (transfer container): a newly-allocated #GSList of * all toplevel widgets of the requested types. Free the returned list with g_slist_free(). * * Since: 2.4 @@ -1201,7 +1201,7 @@ gtk_ui_manager_get_toplevels (GtkUIManager *manager, * Looks up an action by following a path. See gtk_ui_manager_get_widget() * for more information about paths. * - * Return value: (transfer none): the action whose proxy widget is found by following the path, + * Returns: (transfer none): the action whose proxy widget is found by following the path, * or %NULL if no widget was found. * * Since: 2.4 @@ -1413,7 +1413,7 @@ free_node (GNode *node) * Returns an unused merge id, suitable for use with * gtk_ui_manager_add_ui(). * - * Return value: an unused merge id. + * Returns: an unused merge id. * * Since: 2.4 * @@ -1937,7 +1937,7 @@ add_ui_from_string (GtkUIManager *manager, * the current contents of @manager. An enclosing <ui> element is added if * it is missing. * - * Return value: The merge id for the merged UI. The merge id can be used + * Returns: The merge id for the merged UI. The merge id can be used * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, * the return value is 0. * @@ -1981,7 +1981,7 @@ gtk_ui_manager_add_ui_from_string (GtkUIManager *manager, * Parses a file containing a [UI definition][XML-UI] and * merges it with the current contents of @manager. * - * Return value: The merge id for the merged UI. The merge id can be used + * Returns: The merge id for the merged UI. The merge id can be used * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, * the return value is 0. * @@ -2018,7 +2018,7 @@ gtk_ui_manager_add_ui_from_file (GtkUIManager *manager, * Parses a resource file containing a [UI definition][XML-UI] and * merges it with the current contents of @manager. * - * Return value: The merge id for the merged UI. The merge id can be used + * Returns: The merge id for the merged UI. The merge id can be used * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, * the return value is 0. * @@ -3343,7 +3343,7 @@ gtk_ui_manager_buildable_custom_tag_end (GtkBuildable *buildable, * * Creates a [UI definition][XML-UI] of the merged UI. * - * Return value: A newly allocated string containing an XML representation of + * Returns: A newly allocated string containing an XML representation of * the merged UI. * * Since: 2.4 diff --git a/gtk/deprecated/gtkvscale.c b/gtk/deprecated/gtkvscale.c index 3944383b84..4cbcf5eed4 100644 --- a/gtk/deprecated/gtkvscale.c +++ b/gtk/deprecated/gtkvscale.c @@ -100,7 +100,7 @@ gtk_vscale_new (GtkAdjustment *adjustment) * is a power of ten. If the resulting precision is not suitable for your * needs, use gtk_scale_set_digits() to correct it. * - * Return value: a new #GtkVScale + * Returns: a new #GtkVScale * * Deprecated: 3.2: Use gtk_scale_new_with_range() with %GTK_ORIENTATION_VERTICAL instead **/ diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c index 82f721406e..13f37aabaf 100644 --- a/gtk/gtkaboutdialog.c +++ b/gtk/gtkaboutdialog.c @@ -1003,7 +1003,7 @@ gtk_about_dialog_show (GtkWidget *widget) * * Returns the program name displayed in the about dialog. * - * Return value: The program name. The string is owned by the about + * Returns: The program name. The string is owned by the about * dialog and must not be modified. * * Since: 2.12 @@ -1083,7 +1083,7 @@ gtk_about_dialog_set_program_name (GtkAboutDialog *about, * * Returns the version string. * - * Return value: The version string. The string is owned by the about + * Returns: The version string. The string is owned by the about * dialog and must not be modified. * * Since: 2.6 @@ -1131,7 +1131,7 @@ gtk_about_dialog_set_version (GtkAboutDialog *about, * * Returns the copyright string. * - * Return value: The copyright string. The string is owned by the about + * Returns: The copyright string. The string is owned by the about * dialog and must not be modified. * * Since: 2.6 @@ -1190,7 +1190,7 @@ gtk_about_dialog_set_copyright (GtkAboutDialog *about, * * Returns the comments string. * - * Return value: The comments. The string is owned by the about + * Returns: The comments. The string is owned by the about * dialog and must not be modified. * * Since: 2.6 @@ -1247,7 +1247,7 @@ gtk_about_dialog_set_comments (GtkAboutDialog *about, * * Returns the license information. * - * Return value: The license information. The string is owned by the about + * Returns: The license information. The string is owned by the about * dialog and must not be modified. * * Since: 2.6 @@ -1358,7 +1358,7 @@ gtk_about_dialog_set_wrap_license (GtkAboutDialog *about, * * Returns the website URL. * - * Return value: The website URL. The string is owned by the about + * Returns: The website URL. The string is owned by the about * dialog and must not be modified. * * Since: 2.6 @@ -1410,7 +1410,7 @@ gtk_about_dialog_set_website (GtkAboutDialog *about, * * Returns the label used for the website link. * - * Return value: The label used for the website link. The string is + * Returns: The label used for the website link. The string is * owned by the about dialog and must not be modified. * * Since: 2.6 @@ -1463,7 +1463,7 @@ gtk_about_dialog_set_website_label (GtkAboutDialog *about, * Returns the string which are displayed in the authors tab * of the secondary credits dialog. * - * Return value: (array zero-terminated=1) (transfer none): A + * Returns: (array zero-terminated=1) (transfer none): A * %NULL-terminated string array containing the authors. The array is * owned by the about dialog and must not be modified. * @@ -1518,7 +1518,7 @@ gtk_about_dialog_set_authors (GtkAboutDialog *about, * Returns the string which are displayed in the documenters * tab of the secondary credits dialog. * - * Return value: (array zero-terminated=1) (transfer none): A + * Returns: (array zero-terminated=1) (transfer none): A * %NULL-terminated string array containing the documenters. The * array is owned by the about dialog and must not be modified. * @@ -1573,7 +1573,7 @@ gtk_about_dialog_set_documenters (GtkAboutDialog *about, * Returns the string which are displayed in the artists tab * of the secondary credits dialog. * - * Return value: (array zero-terminated=1) (transfer none): A + * Returns: (array zero-terminated=1) (transfer none): A * %NULL-terminated string array containing the artists. The array is * owned by the about dialog and must not be modified. * @@ -1628,7 +1628,7 @@ gtk_about_dialog_set_artists (GtkAboutDialog *about, * Returns the translator credits string which is displayed * in the translators tab of the secondary credits dialog. * - * Return value: The translator credits string. The string is + * Returns: The translator credits string. The string is * owned by the about dialog and must not be modified. * * Since: 2.6 @@ -1690,7 +1690,7 @@ gtk_about_dialog_set_translator_credits (GtkAboutDialog *about, * * Returns the pixbuf displayed as logo in the about dialog. * - * Return value: (transfer none): the pixbuf displayed as logo. The + * Returns: (transfer none): the pixbuf displayed as logo. The * pixbuf is owned by the about dialog. If you want to keep a * reference to it, you have to call g_object_ref() on it. * @@ -1763,7 +1763,7 @@ gtk_about_dialog_set_logo (GtkAboutDialog *about, * * Returns the icon name displayed as logo in the about dialog. * - * Return value: the icon name displayed as logo. The string is + * Returns: the icon name displayed as logo. The string is * owned by the dialog. If you want to keep a reference * to it, you have to call g_strdup() on it. * @@ -2512,7 +2512,7 @@ gtk_about_dialog_set_license_type (GtkAboutDialog *about, * * Retrieves the license set using gtk_about_dialog_set_license_type() * - * Return value: a #GtkLicense value + * Returns: a #GtkLicense value * * Since: 3.0 */ diff --git a/gtk/gtkaccelmap.c b/gtk/gtkaccelmap.c index 0cfef38992..791a593c7c 100644 --- a/gtk/gtkaccelmap.c +++ b/gtk/gtkaccelmap.c @@ -1032,7 +1032,7 @@ gtk_accel_map_init (GtkAccelMap *accel_map) * map via the ::changed signal; it isn’t a parameter to the * other accelerator map functions. * - * Return value: (transfer none): the global #GtkAccelMap object + * Returns: (transfer none): the global #GtkAccelMap object * * Since: 2.4 **/ diff --git a/gtk/gtkactionbar.c b/gtk/gtkactionbar.c index 994a078be6..b951b37ce4 100644 --- a/gtk/gtkactionbar.c +++ b/gtk/gtkactionbar.c @@ -367,7 +367,7 @@ gtk_action_bar_set_center_widget (GtkActionBar *action_bar, * * Retrieves the center bar widget of the bar. * - * Return value: (transfer none): the center #GtkWidget. + * Returns: (transfer none): the center #GtkWidget. * * Since: 3.12 */ diff --git a/gtk/gtkadjustment.c b/gtk/gtkadjustment.c index f550500a8f..9a5087dd23 100644 --- a/gtk/gtkadjustment.c +++ b/gtk/gtkadjustment.c @@ -394,7 +394,7 @@ gtk_adjustment_new (gdouble value, * Gets the current value of the adjustment. See * gtk_adjustment_set_value (). * - * Return value: The current value of the adjustment. + * Returns: The current value of the adjustment. **/ gdouble gtk_adjustment_get_value (GtkAdjustment *adjustment) @@ -446,7 +446,7 @@ gtk_adjustment_set_value (GtkAdjustment *adjustment, * * Retrieves the minimum value of the adjustment. * - * Return value: The current minimum value of the adjustment. + * Returns: The current minimum value of the adjustment. * * Since: 2.14 **/ @@ -495,7 +495,7 @@ gtk_adjustment_set_lower (GtkAdjustment *adjustment, * * Retrieves the maximum value of the adjustment. * - * Return value: The current maximum value of the adjustment. + * Returns: The current maximum value of the adjustment. * * Since: 2.14 **/ @@ -540,7 +540,7 @@ gtk_adjustment_set_upper (GtkAdjustment *adjustment, * * Retrieves the step increment of the adjustment. * - * Return value: The current step increment of the adjustment. + * Returns: The current step increment of the adjustment. * * Since: 2.14 **/ @@ -581,7 +581,7 @@ gtk_adjustment_set_step_increment (GtkAdjustment *adjustment, * * Retrieves the page increment of the adjustment. * - * Return value: The current page increment of the adjustment. + * Returns: The current page increment of the adjustment. * * Since: 2.14 **/ @@ -622,7 +622,7 @@ gtk_adjustment_set_page_increment (GtkAdjustment *adjustment, * * Retrieves the page size of the adjustment. * - * Return value: The current page size of the adjustment. + * Returns: The current page size of the adjustment. * * Since: 2.14 **/ diff --git a/gtk/gtkassistant.c b/gtk/gtkassistant.c index 5a2c9b7777..8b997c2be0 100644 --- a/gtk/gtkassistant.c +++ b/gtk/gtkassistant.c @@ -1457,7 +1457,7 @@ gtk_assistant_remove (GtkContainer *container, * * Creates a new #GtkAssistant. * - * Return value: a newly created #GtkAssistant + * Returns: a newly created #GtkAssistant * * Since: 2.10 */ @@ -1477,7 +1477,7 @@ gtk_assistant_new (void) * * Returns the page number of the current page. * - * Return value: The index (starting from 0) of the current + * Returns: The index (starting from 0) of the current * page in the @assistant, or -1 if the @assistant has no pages, * or no current page. * @@ -1622,7 +1622,7 @@ gtk_assistant_previous_page (GtkAssistant *assistant) * * Returns the number of pages in the @assistant * - * Return value: the number of pages in the @assistant + * Returns: the number of pages in the @assistant * * Since: 2.10 */ @@ -1646,7 +1646,7 @@ gtk_assistant_get_n_pages (GtkAssistant *assistant) * * Returns the child widget contained in page number @page_num. * - * Return value: (transfer none): the child widget, or %NULL + * Returns: (transfer none): the child widget, or %NULL * if @page_num is out of bounds * * Since: 2.10 @@ -1684,7 +1684,7 @@ gtk_assistant_get_nth_page (GtkAssistant *assistant, * * Prepends a page to the @assistant. * - * Return value: the index (starting at 0) of the inserted page + * Returns: the index (starting at 0) of the inserted page * * Since: 2.10 */ @@ -1705,7 +1705,7 @@ gtk_assistant_prepend_page (GtkAssistant *assistant, * * Appends a page to the @assistant. * - * Return value: the index (starting at 0) of the inserted page + * Returns: the index (starting at 0) of the inserted page * * Since: 2.10 */ @@ -1728,7 +1728,7 @@ gtk_assistant_append_page (GtkAssistant *assistant, * * Inserts a page in the @assistant at a given position. * - * Return value: the index (starting from 0) of the inserted page + * Returns: the index (starting from 0) of the inserted page * * Since: 2.10 */ @@ -2000,7 +2000,7 @@ gtk_assistant_set_page_title (GtkAssistant *assistant, * * Gets the title for @page. * - * Return value: the title for @page + * Returns: the title for @page * * Since: 2.10 */ @@ -2079,7 +2079,7 @@ gtk_assistant_set_page_type (GtkAssistant *assistant, * * Gets the page type of @page. * - * Return value: the page type of @page + * Returns: the page type of @page * * Since: 2.10 */ @@ -2163,7 +2163,7 @@ gtk_assistant_do_set_page_header_image (GtkAssistant *assistant, * * Gets the header image for @page. * - * Return value: (transfer none): the header image for @page, + * Returns: (transfer none): the header image for @page, * or %NULL if there’s no header image for the page * * Since: 2.10 @@ -2254,7 +2254,7 @@ gtk_assistant_do_set_page_side_image (GtkAssistant *assistant, * * Gets the side image for @page. * - * Return value: (transfer none): the side image for @page, + * Returns: (transfer none): the side image for @page, * or %NULL if there’s no side image for the page * * Since: 2.10 @@ -2332,7 +2332,7 @@ gtk_assistant_set_page_complete (GtkAssistant *assistant, * * Gets whether @page is complete. * - * Return value: %TRUE if @page is complete. + * Returns: %TRUE if @page is complete. * * Since: 2.10 */ diff --git a/gtk/gtkbbox.c b/gtk/gtkbbox.c index fafcea74ca..02d0b0e279 100644 --- a/gtk/gtkbbox.c +++ b/gtk/gtkbbox.c @@ -395,7 +395,7 @@ gtk_button_box_get_layout (GtkButtonBox *widget) * * Returns whether @child should appear in a secondary group of children. * - * Return value: whether @child should appear in a secondary group of children. + * Returns: whether @child should appear in a secondary group of children. * * Since: 2.4 **/ @@ -1136,7 +1136,7 @@ gtk_button_box_size_allocate (GtkWidget *widget, * * Creates a new #GtkButtonBox. * - * Return value: a new #GtkButtonBox. + * Returns: a new #GtkButtonBox. * * Since: 3.0 */ diff --git a/gtk/gtkbin.c b/gtk/gtkbin.c index 86d1742cb8..9d7a0502e6 100644 --- a/gtk/gtkbin.c +++ b/gtk/gtkbin.c @@ -321,7 +321,7 @@ gtk_bin_size_allocate (GtkWidget *widget, * no child widget. The returned widget does not have a reference * added, so you do not need to unref it. * - * Return value: (transfer none): pointer to child of the #GtkBin + * Returns: (transfer none): pointer to child of the #GtkBin **/ GtkWidget* gtk_bin_get_child (GtkBin *bin) diff --git a/gtk/gtkbindings.c b/gtk/gtkbindings.c index 1741bc1e30..11ce5d3813 100644 --- a/gtk/gtkbindings.c +++ b/gtk/gtkbindings.c @@ -684,7 +684,7 @@ gtk_binding_entry_activate (GtkBindingEntry *entry, * GTK+ maintains a global list of binding sets. Each binding set has * a unique name which needs to be specified upon creation. * - * Return value: (transfer full): new binding set + * Returns: (transfer full): new binding set */ GtkBindingSet* gtk_binding_set_new (const gchar *set_name) @@ -715,7 +715,7 @@ gtk_binding_set_new (const gchar *set_name) * the passed in class structure. New binding sets are created on * demand by this function. * - * Return value: (transfer full): the binding set corresponding to + * Returns: (transfer full): the binding set corresponding to * @object_class */ GtkBindingSet* @@ -766,7 +766,7 @@ gtk_binding_set_find_interned (const gchar *set_name) * The @set_name can either be a name used for gtk_binding_set_new() * or the type name of a class used in gtk_binding_set_by_class(). * - * Return value: (transfer none): %NULL or the specified binding set + * Returns: (transfer none): %NULL or the specified binding set */ GtkBindingSet* gtk_binding_set_find (const gchar *set_name) @@ -786,7 +786,7 @@ gtk_binding_set_find (const gchar *set_name) * Find a key binding matching @keyval and @modifiers within * @binding_set and activate the binding on @object. * - * Return value: %TRUE if a binding was found and activated + * Returns: %TRUE if a binding was found and activated */ gboolean gtk_binding_set_activate (GtkBindingSet *binding_set, @@ -1605,7 +1605,7 @@ gtk_bindings_activate_list (GObject *object, * Find a key binding matching @keyval and @modifiers and activate the * binding on @object. * - * Return value: %TRUE if a binding was found and activated + * Returns: %TRUE if a binding was found and activated */ gboolean gtk_bindings_activate (GObject *object, @@ -1644,7 +1644,7 @@ gtk_bindings_activate (GObject *object, * Looks up key bindings for @object to find one matching * @event, and if one was found, activate it. * - * Return value: %TRUE if a matching key binding was found + * Returns: %TRUE if a matching key binding was found * * Since: 2.4 */ diff --git a/gtk/gtkbox.c b/gtk/gtkbox.c index 9fa7f32d40..6b9391eb8c 100644 --- a/gtk/gtkbox.c +++ b/gtk/gtkbox.c @@ -2000,7 +2000,7 @@ gtk_box_get_preferred_height_for_width (GtkWidget *widget, * * Creates a new #GtkBox. * - * Return value: a new #GtkBox. + * Returns: a new #GtkBox. * * Since: 3.0 **/ @@ -2113,7 +2113,7 @@ gtk_box_set_homogeneous (GtkBox *box, * Returns whether the box is homogeneous (all children are the * same size). See gtk_box_set_homogeneous(). * - * Return value: %TRUE if the box is homogeneous. + * Returns: %TRUE if the box is homogeneous. **/ gboolean gtk_box_get_homogeneous (GtkBox *box) @@ -2158,7 +2158,7 @@ gtk_box_set_spacing (GtkBox *box, * * Gets the value set by gtk_box_set_spacing(). * - * Return value: spacing between children + * Returns: spacing between children **/ gint gtk_box_get_spacing (GtkBox *box) @@ -2208,7 +2208,7 @@ gtk_box_set_baseline_position (GtkBox *box, * * Gets the value set by gtk_box_set_baseline_position(). * - * Return value: the baseline position + * Returns: the baseline position * * Since: 3.10 **/ @@ -2614,7 +2614,7 @@ gtk_box_set_center_widget (GtkBox *box, * * Retrieves the center widget of the box. * - * Return value: the center widget + * Returns: the center widget * * Since: 3.12 */ diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c index 3efe9e925d..fe15875d17 100644 --- a/gtk/gtkbuilder.c +++ b/gtk/gtkbuilder.c @@ -928,7 +928,7 @@ _gtk_builder_finish (GtkBuilder *builder) * Most users will probably want to use gtk_builder_new_from_file(), * gtk_builder_new_from_resource() or gtk_builder_new_from_string(). * - * Return value: a new (empty) #GtkBuilder object + * Returns: a new (empty) #GtkBuilder object * * Since: 2.12 **/ @@ -1391,7 +1391,7 @@ gtk_builder_add_objects_from_string (GtkBuilder *builder, * Gets the object named @name. Note that this function does not * increment the reference count of the returned object. * - * Return value: (transfer none): the object named @name or %NULL if + * Returns: (transfer none): the object named @name or %NULL if * it could not be found in the object tree. * * Since: 2.12 @@ -1422,7 +1422,7 @@ object_add_to_list (gchar *object_id, * this function does not increment the reference counts of the returned * objects. * - * Return value: (element-type GObject) (transfer container): a newly-allocated #GSList containing all the objects + * Returns: (element-type GObject) (transfer container): a newly-allocated #GSList containing all the objects * constructed by the #GtkBuilder instance. It should be freed by * g_slist_free() * @@ -1471,7 +1471,7 @@ gtk_builder_set_translation_domain (GtkBuilder *builder, * * Gets the translation domain of @builder. * - * Return value: the translation domain. This string is owned + * Returns: the translation domain. This string is owned * by the builder object and must not be modified or freed. * * Since: 2.12 diff --git a/gtk/gtkbutton.c b/gtk/gtkbutton.c index 8cfdf39ad3..4c17f90bb0 100644 --- a/gtk/gtkbutton.c +++ b/gtk/gtkbutton.c @@ -2345,7 +2345,7 @@ gtk_button_set_label (GtkButton *button, * case if you create an empty button with gtk_button_new() to * use as a container. * - * Return value: The text of the label widget. This string is owned + * Returns: The text of the label widget. This string is owned * by the widget and must not be modified or freed. **/ const gchar * @@ -2393,7 +2393,7 @@ gtk_button_set_use_underline (GtkButton *button, * Returns whether an embedded underline in the button label indicates a * mnemonic. See gtk_button_set_use_underline (). * - * Return value: %TRUE if an embedded underline in the button label + * Returns: %TRUE if an embedded underline in the button label * indicates the mnemonic accelerator keys. **/ gboolean @@ -2442,7 +2442,7 @@ gtk_button_set_use_stock (GtkButton *button, * * Returns whether the button label is a stock item. * - * Return value: %TRUE if the button label is used to + * Returns: %TRUE if the button label is used to * select a stock item instead of being * used directly as the label text. * @@ -2495,7 +2495,7 @@ gtk_button_set_focus_on_click (GtkButton *button, * Returns whether the button grabs focus when it is clicked with the mouse. * See gtk_button_set_focus_on_click(). * - * Return value: %TRUE if the button grabs focus when it is clicked with + * Returns: %TRUE if the button grabs focus when it is clicked with * the mouse. * * Since: 2.4 @@ -2771,7 +2771,7 @@ gtk_button_set_image (GtkButton *button, * This may have been explicitly set by gtk_button_set_image() * or constructed by gtk_button_new_from_stock(). * - * Return value: (transfer none): a #GtkWidget or %NULL in case there is no image + * Returns: (transfer none): a #GtkWidget or %NULL in case there is no image * * Since: 2.6 */ @@ -2821,7 +2821,7 @@ gtk_button_set_image_position (GtkButton *button, * Gets the position of the image relative to the text * inside the button. * - * Return value: the position + * Returns: the position * * Since: 2.10 */ @@ -2898,7 +2898,7 @@ gtk_button_get_always_show_image (GtkButton *button) * Returns the button’s event window if it is realized, %NULL otherwise. * This function should be rarely needed. * - * Return value: (transfer none): @button’s event window. + * Returns: (transfer none): @button’s event window. * * Since: 2.22 */ diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c index 8e3f807971..00e6a9bfd5 100644 --- a/gtk/gtkcalendar.c +++ b/gtk/gtkcalendar.c @@ -3546,7 +3546,7 @@ gtk_calendar_drag_data_received (GtkWidget *widget, * * Creates a new calendar, with the current date being selected. * - * Return value: a newly #GtkCalendar widget + * Returns: a newly #GtkCalendar widget **/ GtkWidget* gtk_calendar_new (void) @@ -3560,7 +3560,7 @@ gtk_calendar_new (void) * * Returns the current display options of @calendar. * - * Return value: the display options. + * Returns: the display options. * * Since: 2.4 **/ @@ -3996,7 +3996,7 @@ gtk_calendar_set_detail_height_rows (GtkCalendar *calendar, * * Since: 2.14 * - * Return value: The width of detail cells, in characters. + * Returns: The width of detail cells, in characters. */ gint gtk_calendar_get_detail_width_chars (GtkCalendar *calendar) @@ -4015,7 +4015,7 @@ gtk_calendar_get_detail_width_chars (GtkCalendar *calendar) * * Since: 2.14 * - * Return value: The height of detail cells, in rows. + * Returns: The height of detail cells, in rows. */ gint gtk_calendar_get_detail_height_rows (GtkCalendar *calendar) diff --git a/gtk/gtkcalendar.h b/gtk/gtkcalendar.h index 23c50f761d..ad4efcdfc2 100644 --- a/gtk/gtkcalendar.h +++ b/gtk/gtkcalendar.h @@ -86,7 +86,7 @@ typedef enum * * Since: 2.14 * - * Return value: Newly allocated string with Pango markup with details + * Returns: Newly allocated string with Pango markup with details * for the specified day, or %NULL. */ typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar, diff --git a/gtk/gtkcellarea.c b/gtk/gtkcellarea.c index 7b283d6fc0..09d7654d85 100644 --- a/gtk/gtkcellarea.c +++ b/gtk/gtkcellarea.c @@ -1701,7 +1701,7 @@ get_has_renderer (GtkCellRenderer *renderer, * * Checks if @area contains @renderer. * - * Return value: %TRUE if @renderer is in the @area. + * Returns: %TRUE if @renderer is in the @area. * * Since: 3.0 */ @@ -1786,7 +1786,7 @@ gtk_cell_area_foreach_alloc (GtkCellArea *area, * * Delegates event handling to a #GtkCellArea. * - * Return value: %TRUE if the event was handled by @area. + * Returns: %TRUE if the event was handled by @area. * * Since: 3.0 */ @@ -1941,7 +1941,7 @@ get_cell_by_position (GtkCellRenderer *renderer, * Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally * returns the full cell allocation for it inside @cell_area. * - * Return value: (transfer none): the #GtkCellRenderer at @x and @y. + * Returns: (transfer none): the #GtkCellRenderer at @x and @y. * * Since: 3.0 */ @@ -1986,7 +1986,7 @@ gtk_cell_area_get_cell_at_position (GtkCellArea *area, * one should render and handle events with the same #GtkCellAreaContext * which was used to request the size of those rows of data). * - * Return value: (transfer full): a newly created #GtkCellAreaContext which can be used with @area. + * Returns: (transfer full): a newly created #GtkCellAreaContext which can be used with @area. * * Since: 3.0 */ @@ -2015,7 +2015,7 @@ gtk_cell_area_create_context (GtkCellArea *area) * was already used to request all the row widths that are * to be displayed. * - * Return value: (transfer full): a newly created #GtkCellAreaContext copy of @context. + * Returns: (transfer full): a newly created #GtkCellAreaContext copy of @context. * * Since: 3.0 */ @@ -2036,7 +2036,7 @@ gtk_cell_area_copy_context (GtkCellArea *area, * Gets whether the area prefers a height-for-width layout * or a width-for-height layout. * - * Return value: The #GtkSizeRequestMode preferred by @area. + * Returns: The #GtkSizeRequestMode preferred by @area. * * Since: 3.0 */ @@ -2357,7 +2357,7 @@ gtk_cell_area_apply_attributes (GtkCellArea *area, * used to interact with renderers from #GtkCellArea * subclasses. * - * Return value: The current #GtkTreePath string for the current + * Returns: The current #GtkTreePath string for the current * attributes applied to @area. This string belongs to the area and * should not be freed. * @@ -2423,7 +2423,7 @@ gtk_cell_area_class_install_cell_property (GtkCellAreaClass *aclass, * * Finds a cell property of a cell area class by name. * - * Return value: (transfer none): the #GParamSpec of the child property + * Returns: (transfer none): the #GParamSpec of the child property * or %NULL if @aclass has no child property with that name. * * Since: 3.0 @@ -2448,7 +2448,7 @@ gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass, * * Returns all cell properties of a cell area class. * - * Return value: (array length=n_properties) (transfer container): a newly + * Returns: (array length=n_properties) (transfer container): a newly * allocated %NULL-terminated array of #GParamSpec*. The array * must be freed with g_free(). * @@ -2852,7 +2852,7 @@ gtk_cell_area_cell_get_property (GtkCellArea *area, * Returns whether the area can do anything when activated, * after applying new attributes to @area. * - * Return value: whether @area can do anything when activated. + * Returns: whether @area can do anything when activated. * * Since: 3.0 */ @@ -2877,7 +2877,7 @@ gtk_cell_area_is_activatable (GtkCellArea *area) * method to receive and navigate focus in its own way particular * to how it lays out cells. * - * Return value: %TRUE if focus remains inside @area as a result of this call. + * Returns: %TRUE if focus remains inside @area as a result of this call. * * Since: 3.0 */ @@ -2904,7 +2904,7 @@ gtk_cell_area_focus (GtkCellArea *area, * cell, however some subclasses which embed widgets in the area * can also activate a widget if it currently has the focus. * - * Return value: Whether @area was successfully activated. + * Returns: Whether @area was successfully activated. * * Since: 3.0 */ @@ -2974,7 +2974,7 @@ gtk_cell_area_set_focus_cell (GtkCellArea *area, * * Retrieves the currently focused cell for @area * - * Return value: (transfer none): the currently focused cell in @area. + * Returns: (transfer none): the currently focused cell in @area. * * Since: 3.0 */ @@ -3090,7 +3090,7 @@ gtk_cell_area_remove_focus_sibling (GtkCellArea *area, * Returns whether @sibling is one of @renderer’s focus siblings * (see gtk_cell_area_add_focus_sibling()). * - * Return value: %TRUE if @sibling is a focus sibling of @renderer + * Returns: %TRUE if @sibling is a focus sibling of @renderer * * Since: 3.0 */ @@ -3128,7 +3128,7 @@ gtk_cell_area_is_focus_sibling (GtkCellArea *area, * * Gets the focus sibling cell renderers for @renderer. * - * Return value: (element-type GtkCellRenderer) (transfer none): A #GList of #GtkCellRenderers. + * Returns: (element-type GtkCellRenderer) (transfer none): A #GList of #GtkCellRenderers. * The returned list is internal and should not be freed. * * Since: 3.0 @@ -3160,7 +3160,7 @@ gtk_cell_area_get_focus_siblings (GtkCellArea *area, * then chose to activate the focus cell for which the event * cell may have been a sibling. * - * Return value: (transfer none): the #GtkCellRenderer for which @renderer + * Returns: (transfer none): the #GtkCellRenderer for which @renderer * is a sibling, or %NULL. * * Since: 3.0 @@ -3304,7 +3304,7 @@ gtk_cell_area_set_edit_widget (GtkCellArea *area, * Gets the #GtkCellRenderer in @area that is currently * being edited. * - * Return value: (transfer none): The currently edited #GtkCellRenderer + * Returns: (transfer none): The currently edited #GtkCellRenderer * * Since: 3.0 */ @@ -3327,7 +3327,7 @@ gtk_cell_area_get_edited_cell (GtkCellArea *area) * Gets the #GtkCellEditable widget currently used * to edit the currently edited cell. * - * Return value: (transfer none): The currently active #GtkCellEditable widget + * Returns: (transfer none): The currently active #GtkCellEditable widget * * Since: 3.0 */ @@ -3358,7 +3358,7 @@ gtk_cell_area_get_edit_widget (GtkCellArea *area) * for keyboard events for free in its own GtkCellArea->activate() * implementation. * - * Return value: whether cell activation was successful + * Returns: whether cell activation was successful * * Since: 3.0 */ diff --git a/gtk/gtkcellarea.h b/gtk/gtkcellarea.h index d82b2cf842..ed73d99da0 100644 --- a/gtk/gtkcellarea.h +++ b/gtk/gtkcellarea.h @@ -65,7 +65,7 @@ typedef struct _GtkCellAreaContext GtkCellAreaContext; * The type of the callback functions used for iterating over * the cell renderers of a #GtkCellArea, see gtk_cell_area_foreach(). * - * Return value: %TRUE to stop iterating over cells. + * Returns: %TRUE to stop iterating over cells. */ typedef gboolean (*GtkCellCallback) (GtkCellRenderer *renderer, gpointer data); @@ -83,7 +83,7 @@ typedef gboolean (*GtkCellCallback) (GtkCellRenderer *renderer, * cell renderers and their allocated areas inside a #GtkCellArea, * see gtk_cell_area_foreach_alloc(). * - * Return value: %TRUE to stop iterating over cells. + * Returns: %TRUE to stop iterating over cells. */ typedef gboolean (*GtkCellAllocCallback) (GtkCellRenderer *renderer, const GdkRectangle *cell_area, diff --git a/gtk/gtkcellareabox.c b/gtk/gtkcellareabox.c index ec1f89d0b7..05ec4bb957 100644 --- a/gtk/gtkcellareabox.c +++ b/gtk/gtkcellareabox.c @@ -2117,7 +2117,7 @@ _gtk_cell_area_box_group_visible (GtkCellAreaBox *box, * * Creates a new #GtkCellAreaBox. * - * Return value: a newly created #GtkCellAreaBox + * Returns: a newly created #GtkCellAreaBox * * Since: 3.0 */ @@ -2223,7 +2223,7 @@ gtk_cell_area_box_pack_end (GtkCellAreaBox *box, * * Gets the spacing added between cell renderers. * - * Return value: the space added between cell renderers in @box. + * Returns: the space added between cell renderers in @box. * * Since: 3.0 */ diff --git a/gtk/gtkcellareacontext.c b/gtk/gtkcellareacontext.c index f704e953a2..fcdedeee16 100644 --- a/gtk/gtkcellareacontext.c +++ b/gtk/gtkcellareacontext.c @@ -334,7 +334,7 @@ gtk_cell_area_context_real_allocate (GtkCellAreaContext *context, * that the #GtkCellArea is configured with in order to * compute a proper allocation. * - * Return value: (transfer none): the #GtkCellArea this context was created by. + * Returns: (transfer none): the #GtkCellArea this context was created by. * * Since: 3.0 */ diff --git a/gtk/gtkcelllayout.c b/gtk/gtkcelllayout.c index a666cd8e34..af9cee5be3 100644 --- a/gtk/gtkcelllayout.c +++ b/gtk/gtkcelllayout.c @@ -577,7 +577,7 @@ gtk_cell_layout_reorder (GtkCellLayout *cell_layout, * * Returns the cell renderers which have been added to @cell_layout. * - * Return value: (element-type GtkCellRenderer) (transfer container): + * Returns: (element-type GtkCellRenderer) (transfer container): * a list of cell renderers. The list, but not the renderers has * been newly allocated and should be freed with g_list_free() * when no longer needed. @@ -600,7 +600,7 @@ gtk_cell_layout_get_cells (GtkCellLayout *cell_layout) * if called on a #GtkCellArea or might be %NULL if no #GtkCellArea * is used by @cell_layout. * - * Return value: (transfer none): the cell area used by @cell_layout. + * Returns: (transfer none): the cell area used by @cell_layout. * * Since: 3.0 */ diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c index 3afcabc32e..67b6909e70 100644 --- a/gtk/gtkcellrenderer.c +++ b/gtk/gtkcellrenderer.c @@ -799,7 +799,7 @@ gtk_cell_renderer_render (GtkCellRenderer *cell, * Some cell renderers may use events; for example, #GtkCellRendererToggle * toggles when it gets a mouse click. * - * Return value: %TRUE if the event was consumed/handled + * Returns: %TRUE if the event was consumed/handled **/ gboolean gtk_cell_renderer_activate (GtkCellRenderer *cell, @@ -844,7 +844,7 @@ gtk_cell_renderer_activate (GtkCellRenderer *cell, * * Passes an activate event to the cell renderer for possible processing. * - * Return value: (transfer none): A new #GtkCellEditable, or %NULL + * Returns: (transfer none): A new #GtkCellEditable, or %NULL **/ GtkCellEditable * gtk_cell_renderer_start_editing (GtkCellRenderer *cell, diff --git a/gtk/gtkcellrendererpixbuf.c b/gtk/gtkcellrendererpixbuf.c index d4c1b025b8..2271457d7f 100644 --- a/gtk/gtkcellrendererpixbuf.c +++ b/gtk/gtkcellrendererpixbuf.c @@ -410,7 +410,7 @@ gtk_cell_renderer_pixbuf_set_property (GObject *object, * in the model, thus rendering a different image in each row of the * #GtkTreeView. * - * Return value: the new cell renderer + * Returns: the new cell renderer **/ GtkCellRenderer * gtk_cell_renderer_pixbuf_new (void) diff --git a/gtk/gtkcellrendererprogress.c b/gtk/gtkcellrendererprogress.c index 331254c8c2..6c011768ad 100644 --- a/gtk/gtkcellrendererprogress.c +++ b/gtk/gtkcellrendererprogress.c @@ -257,7 +257,7 @@ gtk_cell_renderer_progress_init (GtkCellRendererProgress *cellprogress) * * Creates a new #GtkCellRendererProgress. * - * Return value: the new cell renderer + * Returns: the new cell renderer * * Since: 2.6 **/ diff --git a/gtk/gtkcellrendererspinner.c b/gtk/gtkcellrendererspinner.c index f38fce15d9..a9a50af820 100644 --- a/gtk/gtkcellrendererspinner.c +++ b/gtk/gtkcellrendererspinner.c @@ -176,7 +176,7 @@ gtk_cell_renderer_spinner_init (GtkCellRendererSpinner *cell) * Returns a new cell renderer which will show a spinner to indicate * activity. * - * Return value: a new #GtkCellRenderer + * Returns: a new #GtkCellRenderer * * Since: 2.20 */ diff --git a/gtk/gtkcellrenderertext.c b/gtk/gtkcellrenderertext.c index 34c594340c..fc17b38014 100644 --- a/gtk/gtkcellrenderertext.c +++ b/gtk/gtkcellrenderertext.c @@ -1553,7 +1553,7 @@ gtk_cell_renderer_text_set_property (GObject *object, * value in the model, thus rendering a different string in each row * of the #GtkTreeView * - * Return value: the new cell renderer + * Returns: the new cell renderer **/ GtkCellRenderer * gtk_cell_renderer_text_new (void) diff --git a/gtk/gtkcellrenderertoggle.c b/gtk/gtkcellrenderertoggle.c index e0b7f92108..57f263cb31 100644 --- a/gtk/gtkcellrenderertoggle.c +++ b/gtk/gtkcellrenderertoggle.c @@ -275,7 +275,7 @@ gtk_cell_renderer_toggle_set_property (GObject *object, * in the model, thus causing the check button to reflect the state of * the model. * - * Return value: the new cell renderer + * Returns: the new cell renderer **/ GtkCellRenderer * gtk_cell_renderer_toggle_new (void) @@ -458,7 +458,7 @@ gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle, * * Returns whether we’re rendering radio toggles rather than checkboxes. * - * Return value: %TRUE if we’re rendering radio toggles rather than checkboxes + * Returns: %TRUE if we’re rendering radio toggles rather than checkboxes **/ gboolean gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle) @@ -475,7 +475,7 @@ gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle) * Returns whether the cell renderer is active. See * gtk_cell_renderer_toggle_set_active(). * - * Return value: %TRUE if the cell renderer is active. + * Returns: %TRUE if the cell renderer is active. **/ gboolean gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle) @@ -508,7 +508,7 @@ gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle, * Returns whether the cell renderer is activatable. See * gtk_cell_renderer_toggle_set_activatable(). * - * Return value: %TRUE if the cell renderer is activatable. + * Returns: %TRUE if the cell renderer is activatable. * * Since: 2.18 **/ diff --git a/gtk/gtkcellview.c b/gtk/gtkcellview.c index f577dcd14b..5870f1031f 100644 --- a/gtk/gtkcellview.c +++ b/gtk/gtkcellview.c @@ -936,7 +936,7 @@ row_changed_cb (GtkTreeModel *model, * * Creates a new #GtkCellView widget. * - * Return value: A newly created #GtkCellView widget. + * Returns: A newly created #GtkCellView widget. * * Since: 2.6 */ @@ -964,7 +964,7 @@ gtk_cell_view_new (void) * in this way alignments with cellviews for other rows are * possible. * - * Return value: A newly created #GtkCellView widget. + * Returns: A newly created #GtkCellView widget. * * Since: 2.6 */ @@ -988,7 +988,7 @@ gtk_cell_view_new_with_context (GtkCellArea *area, * Creates a new #GtkCellView widget, adds a #GtkCellRendererText * to it, and makes it show @text. * - * Return value: A newly created #GtkCellView widget. + * Returns: A newly created #GtkCellView widget. * * Since: 2.6 */ @@ -1021,7 +1021,7 @@ gtk_cell_view_new_with_text (const gchar *text) * to it, and makes it show @markup. The text can be * marked up with the [Pango text markup language][PangoMarkupFormat]. * - * Return value: A newly created #GtkCellView widget. + * Returns: A newly created #GtkCellView widget. * * Since: 2.6 */ @@ -1053,7 +1053,7 @@ gtk_cell_view_new_with_markup (const gchar *markup) * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf * to it, and makes it show @pixbuf. * - * Return value: A newly created #GtkCellView widget. + * Returns: A newly created #GtkCellView widget. * * Since: 2.6 */ @@ -1234,7 +1234,7 @@ gtk_cell_view_get_displayed_row (GtkCellView *cell_view) * Sets @requisition to the size needed by @cell_view to display * the model row pointed to by @path. * - * Return value: %TRUE + * Returns: %TRUE * * Since: 2.6 * @@ -1356,7 +1356,7 @@ gtk_cell_view_set_background_rgba (GtkCellView *cell_view, * Gets whether @cell_view is configured to draw all of its * cells in a sensitive state. * - * Return value: whether @cell_view draws all of its + * Returns: whether @cell_view draws all of its * cells in a sensitive state * * Since: 3.0 @@ -1410,7 +1410,7 @@ gtk_cell_view_set_draw_sensitive (GtkCellView *cell_view, * Gets whether @cell_view is configured to request space * to fit the entire #GtkTreeModel. * - * Return value: whether @cell_view requests space to fit + * Returns: whether @cell_view requests space to fit * the entire #GtkTreeModel. * * Since: 3.0 diff --git a/gtk/gtkcheckmenuitem.c b/gtk/gtkcheckmenuitem.c index 7137bc7a42..d79088ccaf 100644 --- a/gtk/gtkcheckmenuitem.c +++ b/gtk/gtkcheckmenuitem.c @@ -339,7 +339,7 @@ gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item, * Returns whether the check menu item is active. See * gtk_check_menu_item_set_active (). * - * Return value: %TRUE if the menu item is checked. + * Returns: %TRUE if the menu item is checked. */ gboolean gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item) @@ -419,7 +419,7 @@ gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item, * * Retrieves the value set by gtk_check_menu_item_set_inconsistent(). * - * Return value: %TRUE if inconsistent + * Returns: %TRUE if inconsistent **/ gboolean gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item) @@ -466,7 +466,7 @@ gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item, * * Returns whether @check_menu_item looks like a #GtkRadioMenuItem * - * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem + * Returns: Whether @check_menu_item looks like a #GtkRadioMenuItem * * Since: 2.4 **/ diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c index b7611c53d2..9c8bc1eb75 100644 --- a/gtk/gtkclipboard.c +++ b/gtk/gtkclipboard.c @@ -344,7 +344,7 @@ clipboard_display_closed (GdkDisplay *display, * if your application called “Foo” has a special-purpose * clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”. * - * Return value: (transfer none): the appropriate clipboard object. If no + * Returns: (transfer none): the appropriate clipboard object. If no * clipboard already exists, a new one will be created. Once a clipboard * object has been created, it is persistent and, since it is owned by * GTK+, must not be freed or unrefd. @@ -370,7 +370,7 @@ gtk_clipboard_get_for_display (GdkDisplay *display, * Returns the clipboard object for the given selection. * See gtk_clipboard_get_for_display() for complete details. * - * Return value: (transfer none): the appropriate clipboard object. If no clipboard + * Returns: (transfer none): the appropriate clipboard object. If no clipboard * already exists, a new one will be created. Once a clipboard * object has been created, it is persistent and, since it is * owned by GTK+, must not be freed or unreffed. @@ -639,7 +639,7 @@ gtk_clipboard_set_contents (GtkClipboard *clipboard, * a list of supported formats for the clipboard data and a function * to call to get the actual data when it is requested. * - * Return value: %TRUE if setting the clipboard data succeeded. + * Returns: %TRUE if setting the clipboard data succeeded. * If setting the clipboard data failed the provided callback * functions will be ignored. **/ @@ -685,7 +685,7 @@ gtk_clipboard_set_with_data (GtkClipboard *clipboard, * is that instead of an generic @user_data pointer, a #GObject is passed * in. * - * Return value: %TRUE if setting the clipboard data succeeded. + * Returns: %TRUE if setting the clipboard data succeeded. * If setting the clipboard data failed the provided callback * functions will be ignored. **/ @@ -720,7 +720,7 @@ gtk_clipboard_set_with_owner (GtkClipboard *clipboard, * gtk_clipboard_clear() has not subsequently called, returns the owner set * by gtk_clipboard_set_with_owner(). * - * Return value: (transfer none): the owner of the clipboard, if any; + * Returns: (transfer none): the owner of the clipboard, if any; * otherwise %NULL. **/ GObject * @@ -1385,7 +1385,7 @@ clipboard_received_func (GtkClipboard *clipboard, * This function waits for the data to be received using the main * loop, so events, timeouts, etc, may be dispatched during the wait. * - * Return value: a newly-allocated #GtkSelectionData object or %NULL + * Returns: a newly-allocated #GtkSelectionData object or %NULL * if retrieving the given target failed. If non-%NULL, * this value must be freed with gtk_selection_data_free() * when you are finished with it. @@ -1438,7 +1438,7 @@ clipboard_text_received_func (GtkClipboard *clipboard, * the data to be received using the main loop, so events, * timeouts, etc, may be dispatched during the wait. * - * Return value: a newly-allocated UTF-8 string which must + * Returns: a newly-allocated UTF-8 string which must * be freed with g_free(), or %NULL if retrieving * the selection data failed. (This could happen * for various reasons, in particular if the @@ -1497,7 +1497,7 @@ clipboard_rich_text_received_func (GtkClipboard *clipboard, * waits for the data to be received using the main loop, so events, * timeouts, etc, may be dispatched during the wait. * - * Return value: (array length=length) (transfer full): a + * Returns: (array length=length) (transfer full): a * newly-allocated binary block of data which must be * freed with g_free(), or %NULL if retrieving the * selection data failed. (This could happen for various @@ -1564,7 +1564,7 @@ clipboard_image_received_func (GtkClipboard *clipboard, * the data to be received using the main loop, so events, * timeouts, etc, may be dispatched during the wait. * - * Return value: (transfer full): a newly-allocated #GdkPixbuf + * Returns: (transfer full): a newly-allocated #GdkPixbuf * object which must be disposed with g_object_unref(), or * %NULL if retrieving the selection data failed. (This could * happen for various reasons, in particular if the clipboard @@ -1618,7 +1618,7 @@ clipboard_uris_received_func (GtkClipboard *clipboard, * for the data to be received using the main loop, so events, * timeouts, etc, may be dispatched during the wait. * - * Return value: (array zero-terminated=1) (element-type utf8) (transfer full): a newly-allocated + * Returns: (array zero-terminated=1) (element-type utf8) (transfer full): a newly-allocated * %NULL-terminated array of strings which must * be freed with g_strfreev(), or %NULL if * retrieving the selection data failed. (This @@ -1660,7 +1660,7 @@ gtk_clipboard_wait_for_uris (GtkClipboard *clipboard) * * Gets the #GdkDisplay associated with @clipboard * - * Return value: (transfer none): the #GdkDisplay associated with @clipboard + * Returns: (transfer none): the #GdkDisplay associated with @clipboard * * Since: 2.2 **/ @@ -1686,7 +1686,7 @@ gtk_clipboard_get_display (GtkClipboard *clipboard) * gtk_clipboard_wait_for_text() since it doesn’t need to retrieve * the actual text. * - * Return value: %TRUE is there is text available, %FALSE otherwise. + * Returns: %TRUE is there is text available, %FALSE otherwise. **/ gboolean gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard) @@ -1719,7 +1719,7 @@ gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard) * gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve * the actual text. * - * Return value: %TRUE is there is rich text available, %FALSE otherwise. + * Returns: %TRUE is there is rich text available, %FALSE otherwise. * * Since: 2.10 **/ @@ -1757,7 +1757,7 @@ gtk_clipboard_wait_is_rich_text_available (GtkClipboard *clipboard, * gtk_clipboard_wait_for_image() since it doesn’t need to retrieve * the actual image data. * - * Return value: %TRUE is there is an image available, %FALSE otherwise. + * Returns: %TRUE is there is an image available, %FALSE otherwise. * * Since: 2.6 **/ @@ -1792,7 +1792,7 @@ gtk_clipboard_wait_is_image_available (GtkClipboard *clipboard) * gtk_clipboard_wait_for_uris() since it doesn’t need to retrieve * the actual URI data. * - * Return value: %TRUE is there is an URI list available, %FALSE otherwise. + * Returns: %TRUE is there is an URI list available, %FALSE otherwise. * * Since: 2.14 **/ @@ -1827,7 +1827,7 @@ gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard) * This function waits for the data to be received using the main * loop, so events, timeouts, etc, may be dispatched during the wait. * - * Return value: %TRUE if any targets are present on the clipboard, + * Returns: %TRUE if any targets are present on the clipboard, * otherwise %FALSE. * * Since: 2.4 @@ -1963,7 +1963,7 @@ gtk_clipboard_owner_change (GtkClipboard *clipboard, * If you want to see if there’s text available on the clipboard, use * gtk_clipboard_wait_is_text_available () instead. * - * Return value: %TRUE if the target is available, %FALSE otherwise. + * Returns: %TRUE if the target is available, %FALSE otherwise. * * Since: 2.6 */ diff --git a/gtk/gtkcolorbutton.c b/gtk/gtkcolorbutton.c index 3738908231..e1d689195b 100644 --- a/gtk/gtkcolorbutton.c +++ b/gtk/gtkcolorbutton.c @@ -707,7 +707,7 @@ gtk_color_button_get_color (GtkColorButton *button, * * Returns the current alpha value. * - * Return value: an integer between 0 and 65535 + * Returns: an integer between 0 and 65535 * * Since: 2.4 * diff --git a/gtk/gtkcolorchooserdialog.c b/gtk/gtkcolorchooserdialog.c index 82e538bb3a..235c7e5a08 100644 --- a/gtk/gtkcolorchooserdialog.c +++ b/gtk/gtkcolorchooserdialog.c @@ -270,7 +270,7 @@ gtk_color_chooser_dialog_iface_init (GtkColorChooserInterface *iface) * * Creates a new #GtkColorChooserDialog. * - * Return value: a new #GtkColorChooserDialog + * Returns: a new #GtkColorChooserDialog * * Since: 3.4 */ diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c index cd5dca9b83..61891773f3 100644 --- a/gtk/gtkcombobox.c +++ b/gtk/gtkcombobox.c @@ -644,7 +644,7 @@ gtk_combo_box_class_init (GtkComboBoxClass *klass) * } * ]| * - * Return value: (transfer full): a newly allocated string representing @path + * Returns: (transfer full): a newly allocated string representing @path * for the current GtkComboBox model. * * Since: 3.4 @@ -3987,7 +3987,7 @@ gtk_combo_box_cell_layout_get_area (GtkCellLayout *cell_layout) * * Creates a new empty #GtkComboBox. * - * Return value: A new #GtkComboBox. + * Returns: A new #GtkComboBox. * * Since: 2.4 */ @@ -4003,7 +4003,7 @@ gtk_combo_box_new (void) * * Creates a new empty #GtkComboBox using @area to layout cells. * - * Return value: A new #GtkComboBox. + * Returns: A new #GtkComboBox. */ GtkWidget * gtk_combo_box_new_with_area (GtkCellArea *area) @@ -4019,7 +4019,7 @@ gtk_combo_box_new_with_area (GtkCellArea *area) * * The new combo box will use @area to layout cells. * - * Return value: A new #GtkComboBox. + * Returns: A new #GtkComboBox. */ GtkWidget * gtk_combo_box_new_with_area_and_entry (GtkCellArea *area) @@ -4036,7 +4036,7 @@ gtk_combo_box_new_with_area_and_entry (GtkCellArea *area) * * Creates a new empty #GtkComboBox with an entry. * - * Return value: A new #GtkComboBox. + * Returns: A new #GtkComboBox. * * Since: 2.24 */ @@ -4052,7 +4052,7 @@ gtk_combo_box_new_with_entry (void) * * Creates a new #GtkComboBox with the model initialized to @model. * - * Return value: A new #GtkComboBox. + * Returns: A new #GtkComboBox. * * Since: 2.4 */ @@ -4075,7 +4075,7 @@ gtk_combo_box_new_with_model (GtkTreeModel *model) * Creates a new empty #GtkComboBox with an entry * and with the model initialized to @model. * - * Return value: A new #GtkComboBox + * Returns: A new #GtkComboBox * * Since: 2.24 */ @@ -4261,7 +4261,7 @@ gtk_combo_box_set_column_span_column (GtkComboBox *combo_box, * `gtk_tree_path_get_indices (path)[0]`, where * `path` is the #GtkTreePath of the active item. * - * Return value: An integer which is the index of the currently active item, + * Returns: An integer which is the index of the currently active item, * or -1 if there’s no active item. * * Since: 2.4 @@ -4409,7 +4409,7 @@ gtk_combo_box_set_active_internal (GtkComboBox *combo_box, * * Sets @iter to point to the current active item, if it exists. * - * Return value: %TRUE, if @iter was set + * Returns: %TRUE, if @iter was set * * Since: 2.4 */ @@ -4544,7 +4544,7 @@ out: * * Returns the #GtkTreeModel which is acting as data source for @combo_box. * - * Return value: (transfer none): A #GtkTreeModel which was passed + * Returns: (transfer none): A #GtkTreeModel which was passed * during construction. * * Since: 2.4 @@ -5015,7 +5015,7 @@ gtk_combo_box_start_editing (GtkCellEditable *cell_editable, * * Gets the current value of the :add-tearoffs property. * - * Return value: the current value of the :add-tearoffs property. + * Returns: the current value of the :add-tearoffs property. * * Deprecated: 3.10 */ @@ -5209,7 +5209,7 @@ gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box) * * Returns the current row separator function. * - * Return value: the current row separator function. + * Returns: the current row separator function. * * Since: 2.6 */ @@ -5298,7 +5298,7 @@ gtk_combo_box_set_button_sensitivity (GtkComboBox *combo_box, * Returns whether the combo box sets the dropdown button * sensitive or not when there are no items in the model. * - * Return Value: %GTK_SENSITIVITY_ON if the dropdown button + * Returns: %GTK_SENSITIVITY_ON if the dropdown button * is sensitive when the model is empty, %GTK_SENSITIVITY_OFF * if the button is always insensitive or * %GTK_SENSITIVITY_AUTO if it is only sensitive as long as @@ -5321,7 +5321,7 @@ gtk_combo_box_get_button_sensitivity (GtkComboBox *combo_box) * * Returns whether the combo box has an entry. * - * Return Value: whether there is an entry in @combo_box. + * Returns: whether there is an entry in @combo_box. * * Since: 2.24 **/ @@ -5378,7 +5378,7 @@ gtk_combo_box_set_entry_text_column (GtkComboBox *combo_box, * Returns the column which @combo_box is using to get the strings * from to display in the internal entry. * - * Return value: A column in the data source model of @combo_box. + * Returns: A column in the data source model of @combo_box. * * Since: 2.24 */ @@ -5430,7 +5430,7 @@ gtk_combo_box_set_focus_on_click (GtkComboBox *combo_box, * Returns whether the combo box grabs focus when it is clicked * with the mouse. See gtk_combo_box_set_focus_on_click(). * - * Return value: %TRUE if the combo box grabs focus when it is + * Returns: %TRUE if the combo box grabs focus when it is * clicked with the mouse. * * Since: 2.6 @@ -5775,7 +5775,7 @@ gtk_combo_box_set_id_column (GtkComboBox *combo_box, * Returns the column which @combo_box is using to get string IDs * for values from. * - * Return value: A column in the data source model of @combo_box. + * Returns: A column in the data source model of @combo_box. * * Since: 3.0 */ @@ -5803,7 +5803,7 @@ gtk_combo_box_get_id_column (GtkComboBox *combo_box) * no row is active, or if the active row has a %NULL ID value, then %NULL * is returned. * - * Return value: the ID of the active row, or %NULL + * Returns: the ID of the active row, or %NULL * * Since: 3.0 **/ diff --git a/gtk/gtkcomboboxtext.c b/gtk/gtkcomboboxtext.c index f07a186e58..9ac057d5e8 100644 --- a/gtk/gtkcomboboxtext.c +++ b/gtk/gtkcomboboxtext.c @@ -313,7 +313,7 @@ gtk_combo_box_text_buildable_custom_finished (GtkBuildable *buildable, * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying * strings. * - * Return value: A new #GtkComboBoxText + * Returns: A new #GtkComboBoxText * * Since: 2.24 */ @@ -330,7 +330,7 @@ gtk_combo_box_text_new (void) * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying * strings. The combo box created by this function has an entry. * - * Return value: a new #GtkComboBoxText + * Returns: a new #GtkComboBoxText * * Since: 2.24 */ diff --git a/gtk/gtkcontainer.c b/gtk/gtkcontainer.c index c65a828504..14031397ff 100644 --- a/gtk/gtkcontainer.c +++ b/gtk/gtkcontainer.c @@ -786,7 +786,7 @@ gtk_container_buildable_custom_tag_end (GtkBuildable *buildable, * children can be added, e.g. for a #GtkPaned which already has two * children. * - * Return value: a #GType. + * Returns: a #GType. **/ GType gtk_container_child_type (GtkContainer *container) @@ -1505,7 +1505,7 @@ gtk_container_set_border_width (GtkContainer *container, * Retrieves the border width of the container. See * gtk_container_set_border_width(). * - * Return value: the current border width + * Returns: the current border width **/ guint gtk_container_get_border_width (GtkContainer *container) @@ -1641,7 +1641,7 @@ gtk_container_set_resize_mode (GtkContainer *container, * Returns the resize mode for the container. See * gtk_container_set_resize_mode (). * - * Return value: the current resize mode + * Returns: the current resize mode * * Deprecated: 3.12: Resize modes are deprecated. They aren’t necessary * anymore since frame clocks and might introduce obscure bugs if @@ -2228,7 +2228,7 @@ gtk_container_get_focus_child (GtkContainer *container) * Returns the container’s non-internal children. See * gtk_container_forall() for details on what constitutes an "internal" child. * - * Return value: (element-type GtkWidget) (transfer container): a newly-allocated list of the container’s non-internal children. + * Returns: (element-type GtkWidget) (transfer container): a newly-allocated list of the container’s non-internal children. **/ GList* gtk_container_get_children (GtkContainer *container) @@ -2934,7 +2934,7 @@ gtk_container_focus_sort_left_right (GtkContainer *container, * Sorts @children in the correct order for focusing with * direction type @direction. * - * Return value: a copy of @children, sorted in correct focusing order, + * Returns: a copy of @children, sorted in correct focusing order, * with children that aren’t suitable for focusing in this direction * removed. **/ @@ -3122,7 +3122,7 @@ gtk_container_set_focus_chain (GtkContainer *container, * of the children. In that case, GTK+ stores %NULL in * @focusable_widgets and returns %FALSE. * - * Return value: %TRUE if the focus chain of the container + * Returns: %TRUE if the focus chain of the container * has been set explicitly. **/ gboolean @@ -3228,7 +3228,7 @@ gtk_container_set_focus_vadjustment (GtkContainer *container, * Retrieves the vertical focus adjustment for the container. See * gtk_container_set_focus_vadjustment(). * - * Return value: (transfer none): the vertical focus adjustment, or %NULL if + * Returns: (transfer none): the vertical focus adjustment, or %NULL if * none has been set. **/ GtkAdjustment * @@ -3283,7 +3283,7 @@ gtk_container_set_focus_hadjustment (GtkContainer *container, * Retrieves the horizontal focus adjustment for the container. See * gtk_container_set_focus_hadjustment (). * - * Return value: (transfer none): the horizontal focus adjustment, or %NULL if + * Returns: (transfer none): the horizontal focus adjustment, or %NULL if * none has been set. **/ GtkAdjustment * diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c index 5eb83b9da4..7efdebd870 100644 --- a/gtk/gtkdialog.c +++ b/gtk/gtkdialog.c @@ -875,7 +875,7 @@ gtk_dialog_new_empty (const gchar *title, * NULL); * ]| * - * Return value: a new #GtkDialog + * Returns: a new #GtkDialog */ GtkWidget* gtk_dialog_new_with_buttons (const gchar *title, @@ -969,7 +969,7 @@ gtk_dialog_add_action_widget (GtkDialog *dialog, * dialog’s action area. The button widget is returned, but usually * you don’t need it. * - * Return value: (transfer none): the #GtkButton widget that was added + * Returns: (transfer none): the #GtkButton widget that was added **/ GtkWidget* gtk_dialog_add_button (GtkDialog *dialog, @@ -1263,7 +1263,7 @@ run_destroy_handler (GtkDialog *dialog, gpointer data) * such as timeouts, IO channel watches, DND drops, etc, will * be triggered during a gtk_dialog_run() call. * - * Return value: response ID + * Returns: response ID **/ gint gtk_dialog_run (GtkDialog *dialog) diff --git a/gtk/gtkdnd.c b/gtk/gtkdnd.c index 29eb74dbb9..308e146f32 100644 --- a/gtk/gtkdnd.c +++ b/gtk/gtkdnd.c @@ -1154,7 +1154,7 @@ gtk_drag_get_data (GtkWidget *widget, * * Determines the source widget for a drag. * - * Return value: (transfer none): if the drag is occurring + * Returns: (transfer none): if the drag is occurring * within a single application, a pointer to the source widget. * Otherwise, %NULL. */ @@ -1498,7 +1498,7 @@ gtk_drag_dest_unset (GtkWidget *widget) * Returns the list of targets this widget can accept from * drag-and-drop. * - * Return value: (transfer none): the #GtkTargetList, or %NULL if none + * Returns: (transfer none): the #GtkTargetList, or %NULL if none **/ GtkTargetList* gtk_drag_dest_get_target_list (GtkWidget *widget) @@ -1664,7 +1664,7 @@ gtk_drag_dest_set_track_motion (GtkWidget *widget, * Returns whether the widget has been configured to always * emit #GtkWidget::drag-motion signals. * - * Return Value: %TRUE if the widget always emits + * Returns: %TRUE if the widget always emits * #GtkWidget::drag-motion events * * Since: 2.10 @@ -1808,7 +1808,7 @@ _gtk_drag_dest_handle_event (GtkWidget *toplevel, * that case, they will have to implement a drag_motion handler that * passes the correct target list to this function. * - * Return value: (transfer none): first target that the source offers + * Returns: (transfer none): first target that the source offers * and the dest can accept, or %GDK_NONE **/ GdkAtom @@ -2694,7 +2694,7 @@ gtk_drag_begin_internal (GtkWidget *widget, * (remember to free the event with gdk_event_free() when you are done). * If you can really not pass a real event, pass #NULL instead. * - * Return value: (transfer none): the context for this drag. + * Returns: (transfer none): the context for this drag. * * Since: 3.10 **/ @@ -2727,7 +2727,7 @@ gtk_drag_begin_with_coordinates (GtkWidget *widget, * This is equivalent to gtk_drag_begin_with_coordinates(), passing -1, -1 * as coordinates. * - * Return value: (transfer none): the context for this drag. + * Returns: (transfer none): the context for this drag. * * Deprecated: 3.10: Use gtk_drag_begin_with_coordinates() instead. **/ @@ -2839,7 +2839,7 @@ gtk_drag_source_unset (GtkWidget *widget) * Gets the list of targets this widget can provide for * drag-and-drop. * - * Return value: (transfer none): the #GtkTargetList, or %NULL if none + * Returns: (transfer none): the #GtkTargetList, or %NULL if none * * Since: 2.4 **/ @@ -4558,7 +4558,7 @@ gtk_drag_abort_timeout (gpointer data) * at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus * should trigger the beginning of a drag-and-drop operation. * - * Return Value: %TRUE if the drag threshold has been passed. + * Returns: %TRUE if the drag threshold has been passed. **/ gboolean gtk_drag_check_threshold (GtkWidget *widget, diff --git a/gtk/gtkeditable.c b/gtk/gtkeditable.c index 996aadb2f6..c0e17da4bf 100644 --- a/gtk/gtkeditable.c +++ b/gtk/gtkeditable.c @@ -247,7 +247,7 @@ gtk_editable_delete_text (GtkEditable *editable, * * Note that positions are specified in characters, not bytes. * - * Return value: a pointer to the contents of the widget as a + * Returns: a pointer to the contents of the widget as a * string. This string is allocated by the #GtkEditable * implementation and should be freed by the caller. */ @@ -292,7 +292,7 @@ gtk_editable_set_position (GtkEditable *editable, * * Note that this position is in characters, not in bytes. * - * Return value: the cursor position + * Returns: the cursor position */ gint gtk_editable_get_position (GtkEditable *editable) @@ -314,7 +314,7 @@ gtk_editable_get_position (GtkEditable *editable) * * Note that positions are specified in characters, not bytes. * - * Return value: %TRUE if an area is selected, %FALSE otherwise + * Returns: %TRUE if an area is selected, %FALSE otherwise */ gboolean gtk_editable_get_selection_bounds (GtkEditable *editable, @@ -450,7 +450,7 @@ gtk_editable_set_editable (GtkEditable *editable, * Retrieves whether @editable is editable. See * gtk_editable_set_editable(). * - * Return value: %TRUE if @editable is editable. + * Returns: %TRUE if @editable is editable. */ gboolean gtk_editable_get_editable (GtkEditable *editable) diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c index a79ccd0a3d..b74ea4e0ab 100644 --- a/gtk/gtkentry.c +++ b/gtk/gtkentry.c @@ -6615,7 +6615,7 @@ gtk_entry_reset_im_context (GtkEntry *entry) * and the default key event handling of the #GtkEntry. * See gtk_text_view_reset_im_context() for an example of use. * - * Return value: %TRUE if the input method handled the key event. + * Returns: %TRUE if the input method handled the key event. * * Since: 2.22 */ @@ -7335,7 +7335,7 @@ gtk_entry_ensure_pixbuf (GtkEntry *entry, * * Creates a new entry. * - * Return value: a new #GtkEntry. + * Returns: a new #GtkEntry. */ GtkWidget* gtk_entry_new (void) @@ -7349,7 +7349,7 @@ gtk_entry_new (void) * * Creates a new entry with the specified text buffer. * - * Return value: a new #GtkEntry + * Returns: a new #GtkEntry * * Since: 2.18 */ @@ -7583,7 +7583,7 @@ gtk_entry_set_visibility (GtkEntry *entry, * Retrieves whether the text in @entry is visible. See * gtk_entry_set_visibility(). * - * Return value: %TRUE if the text is currently visible + * Returns: %TRUE if the text is currently visible **/ gboolean gtk_entry_get_visibility (GtkEntry *entry) @@ -7637,7 +7637,7 @@ gtk_entry_set_invisible_char (GtkEntry *entry, * Retrieves the character displayed in place of the real characters * for entries with visibility set to false. See gtk_entry_set_invisible_char(). * - * Return value: the current invisible char, or 0, if the entry does not + * Returns: the current invisible char, or 0, if the entry does not * show invisible text at all. **/ gunichar @@ -7715,7 +7715,7 @@ gtk_entry_set_overwrite_mode (GtkEntry *entry, * * Gets the value set by gtk_entry_set_overwrite_mode(). * - * Return value: whether the text is overwritten when typing. + * Returns: whether the text is overwritten when typing. * * Since: 2.14 **/ @@ -7742,7 +7742,7 @@ gtk_entry_get_overwrite_mode (GtkEntry *entry) * gtk_entry_buffer_get_text (buffer); * ]| * - * Return value: a pointer to the contents of the widget as a + * Returns: a pointer to the contents of the widget as a * string. This string points to internally allocated * storage in the widget and must not be freed, modified or * stored. @@ -7797,7 +7797,7 @@ gtk_entry_set_max_length (GtkEntry *entry, * gtk_entry_buffer_get_max_length (buffer); * ]| * - * Return value: the maximum allowed number of characters + * Returns: the maximum allowed number of characters * in #GtkEntry, or 0 if there is no maximum. **/ gint @@ -7823,7 +7823,7 @@ gtk_entry_get_max_length (GtkEntry *entry) * gtk_entry_buffer_get_length (buffer); * ]| * - * Return value: the current number of characters + * Returns: the current number of characters * in #GtkEntry, or 0 if there are none. * * Since: 2.14 @@ -7875,7 +7875,7 @@ gtk_entry_set_activates_default (GtkEntry *entry, * * Retrieves the value set by gtk_entry_set_activates_default(). * - * Return value: %TRUE if the entry will activate the default widget + * Returns: %TRUE if the entry will activate the default widget **/ gboolean gtk_entry_get_activates_default (GtkEntry *entry) @@ -7920,7 +7920,7 @@ gtk_entry_set_width_chars (GtkEntry *entry, * * Gets the value set by gtk_entry_set_width_chars(). * - * Return value: number of chars to request space for, or negative if unset + * Returns: number of chars to request space for, or negative if unset **/ gint gtk_entry_get_width_chars (GtkEntry *entry) @@ -7964,7 +7964,7 @@ gtk_entry_set_max_width_chars (GtkEntry *entry, * Retrieves the desired maximum width of @entry, in characters. * See gtk_entry_set_max_width_chars(). * - * Return value: the maximum width of the entry, in characters + * Returns: the maximum width of the entry, in characters * * Since: 3.12 */ @@ -8009,7 +8009,7 @@ gtk_entry_set_has_frame (GtkEntry *entry, * * Gets the value set by gtk_entry_set_has_frame(). * - * Return value: whether the entry has a beveled frame + * Returns: whether the entry has a beveled frame **/ gboolean gtk_entry_get_has_frame (GtkEntry *entry) @@ -8055,7 +8055,7 @@ gtk_entry_set_inner_border (GtkEntry *entry, * This function returns the entry’s #GtkEntry:inner-border property. See * gtk_entry_set_inner_border() for more information. * - * Return value: (transfer none): the entry’s #GtkBorder, or %NULL if none was set. + * Returns: (transfer none): the entry’s #GtkBorder, or %NULL if none was set. * * Since: 2.10 * @@ -8086,7 +8086,7 @@ gtk_entry_get_inner_border (GtkEntry *entry) * gtk_entry_text_index_to_layout_index() are needed to convert byte * indices in the layout to byte indices in the entry contents. * - * Return value: (transfer none): the #PangoLayout for this entry + * Returns: (transfer none): the #PangoLayout for this entry **/ PangoLayout* gtk_entry_get_layout (GtkEntry *entry) @@ -8111,7 +8111,7 @@ gtk_entry_get_layout (GtkEntry *entry) * entry’s #PangoLayout (returned by gtk_entry_get_layout(), * with text retrieved via pango_layout_get_text()). * - * Return value: byte index into the entry contents + * Returns: byte index into the entry contents **/ gint gtk_entry_layout_index_to_text_index (GtkEntry *entry, @@ -8150,7 +8150,7 @@ gtk_entry_layout_index_to_text_index (GtkEntry *entry, * gtk_entry_get_layout()) to a position in the entry contents * (returned by gtk_entry_get_text()). * - * Return value: byte index into the entry layout text + * Returns: byte index into the entry layout text **/ gint gtk_entry_text_index_to_layout_index (GtkEntry *entry, @@ -8267,7 +8267,7 @@ gtk_entry_set_alignment (GtkEntry *entry, gfloat xalign) * * Gets the value set by gtk_entry_set_alignment(). * - * Return value: the alignment + * Returns: the alignment * * Since: 2.4 **/ @@ -8836,7 +8836,7 @@ gtk_entry_get_icon_sensitive (GtkEntry *entry, * to store image data. If the icon has no image data, * the return value will be %GTK_IMAGE_EMPTY. * - * Return value: image representation being used + * Returns: image representation being used * * Since: 2.16 **/ @@ -10200,7 +10200,7 @@ gtk_entry_set_completion (GtkEntry *entry, * * Returns the auxiliary completion object currently in use by @entry. * - * Return value: (transfer none): The auxiliary completion object currently + * Returns: (transfer none): The auxiliary completion object currently * in use by @entry. * * Since: 2.4 @@ -10258,7 +10258,7 @@ gtk_entry_set_cursor_hadjustment (GtkEntry *entry, * Retrieves the horizontal cursor adjustment for the entry. * See gtk_entry_set_cursor_hadjustment(). * - * Return value: (transfer none): the horizontal cursor adjustment, or %NULL + * Returns: (transfer none): the horizontal cursor adjustment, or %NULL * if none has been set. * * Since: 2.12 @@ -10330,7 +10330,7 @@ gtk_entry_set_progress_fraction (GtkEntry *entry, * Returns the current fraction of the task that’s been completed. * See gtk_entry_set_progress_fraction(). * - * Return value: a fraction from 0.0 to 1.0 + * Returns: a fraction from 0.0 to 1.0 * * Since: 2.16 */ @@ -10380,7 +10380,7 @@ gtk_entry_set_progress_pulse_step (GtkEntry *entry, * * Retrieves the pulse step set with gtk_entry_set_progress_pulse_step(). * - * Return value: a fraction from 0.0 to 1.0 + * Returns: a fraction from 0.0 to 1.0 * * Since: 2.16 */ @@ -10715,7 +10715,7 @@ gtk_entry_set_attributes (GtkEntry *entry, * Gets the attribute list that was set on the entry using * gtk_entry_set_attributes(), if any. * - * Return value: (transfer none): the attribute list, or %NULL + * Returns: (transfer none): the attribute list, or %NULL * if none was set. * * Since: 3.6 @@ -10768,7 +10768,7 @@ gtk_entry_set_tabs (GtkEntry *entry, * Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if * any. * - * Return value: (transfer none): the tabstops, or %NULL if none was set. + * Returns: (transfer none): the tabstops, or %NULL if none was set. * * Since: 3.10 */ diff --git a/gtk/gtkentrybuffer.c b/gtk/gtkentrybuffer.c index cf72518078..8356d9515b 100644 --- a/gtk/gtkentrybuffer.c +++ b/gtk/gtkentrybuffer.c @@ -436,7 +436,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass) * * Optionally, specify initial text to set in the buffer. * - * Return value: A new GtkEntryBuffer object. + * Returns: A new GtkEntryBuffer object. * * Since: 2.18 **/ @@ -456,7 +456,7 @@ gtk_entry_buffer_new (const gchar *initial_chars, * * Retrieves the length in characters of the buffer. * - * Return value: The number of characters in the buffer. + * Returns: The number of characters in the buffer. * * Since: 2.18 **/ @@ -480,7 +480,7 @@ gtk_entry_buffer_get_length (GtkEntryBuffer *buffer) * Retrieves the length in bytes of the buffer. * See gtk_entry_buffer_get_length(). * - * Return value: The byte length of the buffer. + * Returns: The byte length of the buffer. * * Since: 2.18 **/ @@ -508,7 +508,7 @@ gtk_entry_buffer_get_bytes (GtkEntryBuffer *buffer) * The memory pointer returned by this call will not change * unless this object emits a signal, or is finalized. * - * Return value: a pointer to the contents of the widget as a + * Returns: a pointer to the contents of the widget as a * string. This string points to internally allocated * storage in the buffer and must not be freed, modified or * stored. @@ -592,7 +592,7 @@ gtk_entry_buffer_set_max_length (GtkEntryBuffer *buffer, * Retrieves the maximum allowed length of the text in * @buffer. See gtk_entry_buffer_set_max_length(). * - * Return value: the maximum allowed number of characters + * Returns: the maximum allowed number of characters * in #GtkEntryBuffer, or 0 if there is no maximum. * * Since: 2.18 diff --git a/gtk/gtkentrycompletion.c b/gtk/gtkentrycompletion.c index 391336d702..3318144fb5 100644 --- a/gtk/gtkentrycompletion.c +++ b/gtk/gtkentrycompletion.c @@ -235,7 +235,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass) * the #GtkFileChooser inserts only the part of the prefix up to the * next '/'. * - * Return value: %TRUE if the signal has been handled + * Returns: %TRUE if the signal has been handled * * Since: 2.6 */ @@ -263,7 +263,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass) * Note that @model is the model that was passed to * gtk_entry_completion_set_model(). * - * Return value: %TRUE if the signal has been handled + * Returns: %TRUE if the signal has been handled * * Since: 2.4 */ @@ -292,7 +292,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass) * Note that @model is the model that was passed to * gtk_entry_completion_set_model(). * - * Return value: %TRUE if the signal has been handled + * Returns: %TRUE if the signal has been handled * * Since: 2.12 */ @@ -1139,7 +1139,7 @@ gtk_entry_completion_selection_changed (GtkTreeSelection *selection, * * Creates a new #GtkEntryCompletion object. * - * Return value: A newly created #GtkEntryCompletion object + * Returns: A newly created #GtkEntryCompletion object * * Since: 2.4 */ @@ -1161,7 +1161,7 @@ gtk_entry_completion_new (void) * specified @area to layout cells in the underlying * #GtkTreeViewColumn for the drop-down menu. * - * Return value: A newly created #GtkEntryCompletion object + * Returns: A newly created #GtkEntryCompletion object * * Since: 3.0 */ @@ -1181,7 +1181,7 @@ gtk_entry_completion_new_with_area (GtkCellArea *area) * * Gets the entry @completion has been attached to. * - * Return value: (transfer none): The entry @completion has been attached to + * Returns: (transfer none): The entry @completion has been attached to * * Since: 2.4 */ @@ -1245,7 +1245,7 @@ gtk_entry_completion_set_model (GtkEntryCompletion *completion, * Returns the model the #GtkEntryCompletion is using as data source. * Returns %NULL if the model is unset. * - * Return value: (transfer none): A #GtkTreeModel, or %NULL if none + * Returns: (transfer none): A #GtkTreeModel, or %NULL if none * is currently being used * * Since: 2.4 @@ -1323,7 +1323,7 @@ gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion, * * Returns the minimum key length as set for @completion. * - * Return value: The currently used minimum key length + * Returns: The currently used minimum key length * * Since: 2.4 */ @@ -1538,7 +1538,7 @@ gtk_entry_completion_set_text_column (GtkEntryCompletion *completion, * * Returns the column in the model of @completion to get strings from. * - * Return value: the column containing the strings + * Returns: the column containing the strings * * Since: 2.6 */ @@ -2049,7 +2049,7 @@ gtk_entry_completion_set_inline_completion (GtkEntryCompletion *completion, * Returns whether the common prefix of the possible completions should * be automatically inserted in the entry. * - * Return value: %TRUE if inline completion is turned on + * Returns: %TRUE if inline completion is turned on * * Since: 2.6 */ @@ -2093,7 +2093,7 @@ gtk_entry_completion_set_popup_completion (GtkEntryCompletion *completion, * * Returns whether the completions should be presented in a popup window. * - * Return value: %TRUE if popup completion is turned on + * Returns: %TRUE if popup completion is turned on * * Since: 2.6 */ @@ -2138,7 +2138,7 @@ gtk_entry_completion_set_popup_set_width (GtkEntryCompletion *completion, * Returns whether the completion popup window will be resized to the * width of the entry. * - * Return value: %TRUE if the popup window will be resized to the width of + * Returns: %TRUE if the popup window will be resized to the width of * the entry * * Since: 2.8 @@ -2187,7 +2187,7 @@ gtk_entry_completion_set_popup_single_match (GtkEntryCompletion *completion, * Returns whether the completion popup window will appear even if there is * only a single match. * - * Return value: %TRUE if the popup window will appear regardless of the + * Returns: %TRUE if the popup window will appear regardless of the * number of matches * * Since: 2.8 diff --git a/gtk/gtkeventbox.c b/gtk/gtkeventbox.c index 97c72ecdde..9cd57fa2ac 100644 --- a/gtk/gtkeventbox.c +++ b/gtk/gtkeventbox.c @@ -205,7 +205,7 @@ gtk_event_box_get_property (GObject *object, * Returns whether the event box has a visible window. * See gtk_event_box_set_visible_window() for details. * - * Return value: %TRUE if the event box window is visible + * Returns: %TRUE if the event box window is visible * * Since: 2.4 */ @@ -308,7 +308,7 @@ gtk_event_box_set_visible_window (GtkEventBox *event_box, * windows of its child. See gtk_event_box_set_above_child() * for details. * - * Return value: %TRUE if the event box window is above the + * Returns: %TRUE if the event box window is above the * window of its child * * Since: 2.4 diff --git a/gtk/gtkexpander.c b/gtk/gtkexpander.c index ee5cbe9e21..0380e6bae6 100644 --- a/gtk/gtkexpander.c +++ b/gtk/gtkexpander.c @@ -1630,7 +1630,7 @@ gtk_expander_get_preferred_width_for_height (GtkWidget *widget, * * Creates a new expander using @label as the text of the label. * - * Return value: a new #GtkExpander widget. + * Returns: a new #GtkExpander widget. * * Since: 2.4 */ @@ -1652,7 +1652,7 @@ gtk_expander_new (const gchar *label) * accelerator called a mnemonic. * Pressing Alt and that key activates the button. * - * Return value: a new #GtkExpander widget. + * Returns: a new #GtkExpander widget. * * Since: 2.4 */ @@ -1717,7 +1717,7 @@ gtk_expander_set_expanded (GtkExpander *expander, * * See gtk_expander_set_expanded(). * - * Return value: the current state of the expander + * Returns: the current state of the expander * * Since: 2.4 */ @@ -1762,7 +1762,7 @@ gtk_expander_set_spacing (GtkExpander *expander, * * Gets the value set by gtk_expander_set_spacing(). * - * Return value: spacing between the expander and child + * Returns: spacing between the expander and child * * Since: 2.4 */ @@ -1826,7 +1826,7 @@ gtk_expander_set_label (GtkExpander *expander, * be avoided by fetching the label text directly from the label * widget. * - * Return value: The text of the label widget. This string is owned + * Returns: The text of the label widget. This string is owned * by the widget and must not be modified or freed. * * Since: 2.4 @@ -1886,7 +1886,7 @@ gtk_expander_set_use_underline (GtkExpander *expander, * Returns whether an embedded underline in the expander label * indicates a mnemonic. See gtk_expander_set_use_underline(). * - * Return value: %TRUE if an embedded underline in the expander + * Returns: %TRUE if an embedded underline in the expander * label indicates the mnemonic accelerator keys * * Since: 2.4 @@ -1941,7 +1941,7 @@ gtk_expander_set_use_markup (GtkExpander *expander, * the [Pango text markup language][PangoMarkupFormat]. * See gtk_expander_set_use_markup(). * - * Return value: %TRUE if the label’s text will be parsed for markup + * Returns: %TRUE if the label’s text will be parsed for markup * * Since: 2.4 */ @@ -2016,7 +2016,7 @@ gtk_expander_set_label_widget (GtkExpander *expander, * Retrieves the label widget for the frame. See * gtk_expander_set_label_widget(). * - * Return value: (transfer none): the label widget, + * Returns: (transfer none): the label widget, * or %NULL if there is none * * Since: 2.4 @@ -2070,7 +2070,7 @@ gtk_expander_set_label_fill (GtkExpander *expander, * Returns whether the label widget will fill all available * horizontal space allocated to @expander. * - * Return value: %TRUE if the label widget will fill all + * Returns: %TRUE if the label widget will fill all * available horizontal space * * Since: 2.22 @@ -2113,7 +2113,7 @@ gtk_expander_set_resize_toplevel (GtkExpander *expander, * Returns whether the expander will resize the toplevel widget * containing the expander upon resizing and collpasing. * - * Return value: the “resize toplevel” setting. + * Returns: the “resize toplevel” setting. * * Since: 3.2 */ diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c index 4df4afb35c..5b27dfe06a 100644 --- a/gtk/gtkfilechooser.c +++ b/gtk/gtkfilechooser.c @@ -467,7 +467,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface) * * Registers an error quark for #GtkFileChooser if necessary. * - * Return value: The error quark used for #GtkFileChooser errors. + * Returns: The error quark used for #GtkFileChooser errors. * * Since: 2.4 **/ @@ -506,7 +506,7 @@ gtk_file_chooser_set_action (GtkFileChooser *chooser, * Gets the type of operation that the file chooser is performing; see * gtk_file_chooser_set_action(). * - * Return value: the action that the file selector is performing + * Returns: the action that the file selector is performing * * Since: 2.4 **/ @@ -559,7 +559,7 @@ gtk_file_chooser_set_local_only (GtkFileChooser *chooser, * Gets whether only local files can be selected in the * file selector. See gtk_file_chooser_set_local_only() * - * Return value: %TRUE if only local files can be selected. + * Returns: %TRUE if only local files can be selected. * * Since: 2.4 **/ @@ -602,7 +602,7 @@ gtk_file_chooser_set_select_multiple (GtkFileChooser *chooser, * Gets whether multiple files can be selected in the file * selector. See gtk_file_chooser_set_select_multiple(). * - * Return value: %TRUE if multiple files can be selected. + * Returns: %TRUE if multiple files can be selected. * * Since: 2.4 **/ @@ -645,7 +645,7 @@ gtk_file_chooser_set_create_folders (GtkFileChooser *chooser, * Gets whether file choser will offer to create new folders. * See gtk_file_chooser_set_create_folders(). * - * Return value: %TRUE if the New Folder button should be displayed. + * Returns: %TRUE if the New Folder button should be displayed. * * Since: 2.18 **/ @@ -673,7 +673,7 @@ gtk_file_chooser_get_create_folders (GtkFileChooser *chooser) * If the file chooser is in folder mode, this function returns the selected * folder. * - * Return value: (type filename): The currently selected filename, or %NULL + * Returns: (type filename): The currently selected filename, or %NULL * if no file is selected, or the selected file can't * be represented with a local filename. Free with g_free(). * @@ -736,7 +736,7 @@ gtk_file_chooser_get_filename (GtkFileChooser *chooser) * as to where to save his new file. In the second case, the file’s existing location * is already known, so the file chooser will use it. * - * Return value: Not useful. + * Returns: Not useful. * * Since: 2.4 **/ @@ -759,7 +759,7 @@ gtk_file_chooser_set_filename (GtkFileChooser *chooser, * folder of @chooser, then the current folder of @chooser will * be changed to the folder containing @filename. * - * Return value: Not useful. + * Returns: Not useful. * * See also: gtk_file_chooser_set_filename() * @@ -856,7 +856,7 @@ file_to_uri_with_native_path (GFile *file) * folder cannot be represented as local filenames they will be ignored. (See * gtk_file_chooser_get_uris()) * - * Return value: (element-type filename) (transfer full): a #GSList + * Returns: (element-type filename) (transfer full): a #GSList * containing the filenames of all selected files and subfolders in * the current folder. Free the returned list with g_slist_free(), * and the filenames with g_free(). @@ -892,7 +892,7 @@ gtk_file_chooser_get_filenames (GtkFileChooser *chooser) * [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up] * for the rationale behind this. * - * Return value: Not useful. + * Returns: Not useful. * * Since: 2.4 **/ @@ -928,7 +928,7 @@ gtk_file_chooser_set_current_folder (GtkFileChooser *chooser, * currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the * usual way to get the selection. * - * Return value: (type filename): the full path of the current folder, + * Returns: (type filename): the full path of the current folder, * or %NULL if the current path cannot be represented as a local * filename. Free with g_free(). This function will also return * %NULL if the file chooser was unable to load the last folder that @@ -1022,7 +1022,7 @@ gtk_file_chooser_get_current_name (GtkFileChooser *chooser) * If the file chooser is in folder mode, this function returns the selected * folder. * - * Return value: The currently selected URI, or %NULL + * Returns: The currently selected URI, or %NULL * if no file is selected. If gtk_file_chooser_set_local_only() is set to %TRUE * (the default) a local URI will be returned for any FUSE locations. * Free with g_free() @@ -1089,7 +1089,7 @@ gtk_file_chooser_get_uri (GtkFileChooser *chooser) * as to where to save his new file. In the second case, the file’s existing location * is already known, so the file chooser will use it. * - * Return value: Not useful. + * Returns: Not useful. * * Since: 2.4 **/ @@ -1112,7 +1112,7 @@ gtk_file_chooser_set_uri (GtkFileChooser *chooser, * file in the current folder of @chooser, then the current folder of * @chooser will be changed to the folder containing @filename. * - * Return value: Not useful. + * Returns: Not useful. * * Since: 2.4 **/ @@ -1198,7 +1198,7 @@ gtk_file_chooser_unselect_all (GtkFileChooser *chooser) * Lists all the selected files and subfolders in the current folder of * @chooser. The returned names are full absolute URIs. * - * Return value: (element-type utf8) (transfer full): a #GSList containing the URIs of all selected + * Returns: (element-type utf8) (transfer full): a #GSList containing the URIs of all selected * files and subfolders in the current folder. Free the returned list * with g_slist_free(), and the filenames with g_free(). * @@ -1237,7 +1237,7 @@ gtk_file_chooser_get_uris (GtkFileChooser *chooser) * [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up] * for the rationale behind this. * - * Return value: %TRUE if the folder could be changed successfully, %FALSE + * Returns: %TRUE if the folder could be changed successfully, %FALSE * otherwise. * * Since: 2.4 @@ -1274,7 +1274,7 @@ gtk_file_chooser_set_current_folder_uri (GtkFileChooser *chooser, * currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the * usual way to get the selection. * - * Return value: the URI for the current folder. Free with g_free(). This + * Returns: the URI for the current folder. Free with g_free(). This * function will also return %NULL if the file chooser was unable to load the * last folder that was requested from it; for example, as would be for calling * gtk_file_chooser_set_current_folder_uri() on a nonexistent folder. @@ -1308,7 +1308,7 @@ gtk_file_chooser_get_current_folder_uri (GtkFileChooser *chooser) * Sets the current folder for @chooser from a #GFile. * Internal function, see gtk_file_chooser_set_current_folder_uri(). * - * Return value: %TRUE if the folder could be changed successfully, %FALSE + * Returns: %TRUE if the folder could be changed successfully, %FALSE * otherwise. * * Since: 2.14 @@ -1332,7 +1332,7 @@ gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser, * Gets the current folder of @chooser as #GFile. * See gtk_file_chooser_get_current_folder_uri(). * - * Return value: (transfer full): the #GFile for the current folder. + * Returns: (transfer full): the #GFile for the current folder. * * Since: 2.14 */ @@ -1353,7 +1353,7 @@ gtk_file_chooser_get_current_folder_file (GtkFileChooser *chooser) * Selects the file referred to by @file. An internal function. See * _gtk_file_chooser_select_uri(). * - * Return value: Not useful. + * Returns: Not useful. * * Since: 2.14 **/ @@ -1396,7 +1396,7 @@ gtk_file_chooser_unselect_file (GtkFileChooser *chooser, * Lists all the selected files and subfolders in the current folder of @chooser * as #GFile. An internal function, see gtk_file_chooser_get_uris(). * - * Return value: (element-type GFile) (transfer full): a #GSList + * Returns: (element-type GFile) (transfer full): a #GSList * containing a #GFile for each selected file and subfolder in the * current folder. Free the returned list with g_slist_free(), and * the files with g_object_unref(). @@ -1451,7 +1451,7 @@ gtk_file_chooser_get_files (GtkFileChooser *chooser) * } * ]| * - * Return value: Not useful. + * Returns: Not useful. * * Since: 2.14 **/ @@ -1513,7 +1513,7 @@ gtk_file_chooser_get_file (GtkFileChooser *chooser) * implementation detail, used for conversion between paths * and filenames and URIs. * - * Return value: the file system for @chooser. + * Returns: the file system for @chooser. * * Since: 2.4 **/ @@ -1563,7 +1563,7 @@ gtk_file_chooser_set_preview_widget (GtkFileChooser *chooser, * Gets the current preview widget; see * gtk_file_chooser_set_preview_widget(). * - * Return value: (transfer none): the current preview widget, or %NULL + * Returns: (transfer none): the current preview widget, or %NULL * * Since: 2.4 **/ @@ -1617,7 +1617,7 @@ gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser, * should be shown for the current filename. See * gtk_file_chooser_set_preview_widget_active(). * - * Return value: %TRUE if the preview widget is active for the current filename. + * Returns: %TRUE if the preview widget is active for the current filename. * * Since: 2.4 **/ @@ -1663,7 +1663,7 @@ gtk_file_chooser_set_use_preview_label (GtkFileChooser *chooser, * Gets whether a stock label should be drawn with the name of the previewed * file. See gtk_file_chooser_set_use_preview_label(). * - * Return value: %TRUE if the file chooser is set to display a label with the + * Returns: %TRUE if the file chooser is set to display a label with the * name of the previewed file, %FALSE otherwise. **/ gboolean @@ -1685,7 +1685,7 @@ gtk_file_chooser_get_use_preview_label (GtkFileChooser *chooser) * Gets the #GFile that should be previewed in a custom preview * Internal function, see gtk_file_chooser_get_preview_uri(). * - * Return value: (transfer full): the #GFile for the file to preview, + * Returns: (transfer full): the #GFile for the file to preview, * or %NULL if no file is selected. Free with g_object_unref(). * * Since: 2.14 @@ -1707,7 +1707,7 @@ gtk_file_chooser_get_preview_file (GtkFileChooser *chooser) * Adds a folder to be displayed with the shortcut folders in a file chooser. * Internal function, see gtk_file_chooser_add_shortcut_folder(). * - * Return value: %TRUE if the folder could be added successfully, %FALSE + * Returns: %TRUE if the folder could be added successfully, %FALSE * otherwise. * * Since: 2.4 @@ -1732,7 +1732,7 @@ _gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser, * Removes a folder from the shortcut folders in a file chooser. Internal * function, see gtk_file_chooser_remove_shortcut_folder(). * - * Return value: %TRUE if the folder could be removed successfully, %FALSE + * Returns: %TRUE if the folder could be removed successfully, %FALSE * otherwise. * * Since: 2.4 @@ -1755,7 +1755,7 @@ _gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser, * Gets the filename that should be previewed in a custom preview * widget. See gtk_file_chooser_set_preview_widget(). * - * Return value: (type filename): the filename to preview, or %NULL if + * Returns: (type filename): the filename to preview, or %NULL if * no file is selected, or if the selected file cannot be represented * as a local filename. Free with g_free() * @@ -1786,7 +1786,7 @@ gtk_file_chooser_get_preview_filename (GtkFileChooser *chooser) * Gets the URI that should be previewed in a custom preview * widget. See gtk_file_chooser_set_preview_widget(). * - * Return value: the URI for the file to preview, or %NULL if no file is + * Returns: the URI for the file to preview, or %NULL if no file is * selected. Free with g_free(). * * Since: 2.4 @@ -1834,7 +1834,7 @@ gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser, * Gets the current preview widget; see * gtk_file_chooser_set_extra_widget(). * - * Return value: (transfer none): the current extra widget, or %NULL + * Returns: (transfer none): the current extra widget, or %NULL * * Since: 2.4 **/ @@ -1905,7 +1905,7 @@ gtk_file_chooser_remove_filter (GtkFileChooser *chooser, * Lists the current set of user-selectable filters; see * gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter(). * - * Return value: (element-type GtkFileFilter) (transfer container): a + * Returns: (element-type GtkFileFilter) (transfer container): a * #GSList containing the current set of user selectable filters. The * contents of the list are owned by GTK+, but you must free the list * itself with g_slist_free() when you are done with it. @@ -1950,7 +1950,7 @@ gtk_file_chooser_set_filter (GtkFileChooser *chooser, * * Gets the current filter; see gtk_file_chooser_set_filter(). * - * Return value: (transfer none): the current filter, or %NULL + * Returns: (transfer none): the current filter, or %NULL * * Since: 2.4 **/ @@ -1983,7 +1983,7 @@ gtk_file_chooser_get_filter (GtkFileChooser *chooser) * application. For example, you can use this to add a * “/usr/share/mydrawprogram/Clipart” folder to the volume list. * - * Return value: %TRUE if the folder could be added successfully, %FALSE + * Returns: %TRUE if the folder could be added successfully, %FALSE * otherwise. In the latter case, the @error will be set as appropriate. * * Since: 2.4 @@ -2014,7 +2014,7 @@ gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser, * * Removes a folder from a file chooser’s list of shortcut folders. * - * Return value: %TRUE if the operation succeeds, %FALSE otherwise. + * Returns: %TRUE if the operation succeeds, %FALSE otherwise. * In the latter case, the @error will be set as appropriate. * * See also: gtk_file_chooser_add_shortcut_folder() @@ -2046,7 +2046,7 @@ gtk_file_chooser_remove_shortcut_folder (GtkFileChooser *chooser, * Queries the list of shortcut folders in the file chooser, as set by * gtk_file_chooser_add_shortcut_folder(). * - * Return value: (element-type filename) (transfer full): A list of + * Returns: (element-type filename) (transfer full): A list of * folder filenames, or %NULL if there are no shortcut folders. Free * the returned list with g_slist_free(), and the filenames with * g_free(). @@ -2081,7 +2081,7 @@ gtk_file_chooser_list_shortcut_folders (GtkFileChooser *chooser) * by the application. For example, you can use this to add a * “file:///usr/share/mydrawprogram/Clipart” folder to the volume list. * - * Return value: %TRUE if the folder could be added successfully, %FALSE + * Returns: %TRUE if the folder could be added successfully, %FALSE * otherwise. In the latter case, the @error will be set as appropriate. * * Since: 2.4 @@ -2112,7 +2112,7 @@ gtk_file_chooser_add_shortcut_folder_uri (GtkFileChooser *chooser, * * Removes a folder URI from a file chooser’s list of shortcut folders. * - * Return value: %TRUE if the operation succeeds, %FALSE otherwise. + * Returns: %TRUE if the operation succeeds, %FALSE otherwise. * In the latter case, the @error will be set as appropriate. * * See also: gtk_file_chooser_add_shortcut_folder_uri() @@ -2144,7 +2144,7 @@ gtk_file_chooser_remove_shortcut_folder_uri (GtkFileChooser *chooser, * Queries the list of shortcut folders in the file chooser, as set by * gtk_file_chooser_add_shortcut_folder_uri(). * - * Return value: (element-type utf8) (transfer full): A list of folder + * Returns: (element-type utf8) (transfer full): A list of folder * URIs, or %NULL if there are no shortcut folders. Free the returned * list with g_slist_free(), and the URIs with g_free(). * @@ -2200,7 +2200,7 @@ gtk_file_chooser_set_show_hidden (GtkFileChooser *chooser, * Gets whether hidden files and folders are displayed in the file selector. * See gtk_file_chooser_set_show_hidden(). * - * Return value: %TRUE if hidden files and folders are displayed. + * Returns: %TRUE if hidden files and folders are displayed. * * Since: 2.6 **/ @@ -2251,7 +2251,7 @@ gtk_file_chooser_set_do_overwrite_confirmation (GtkFileChooser *chooser, * Queries whether a file chooser is set to confirm for overwriting when the user * types a file name that already exists. * - * Return value: %TRUE if the file chooser will present a confirmation dialog; + * Returns: %TRUE if the file chooser will present a confirmation dialog; * %FALSE otherwise. * * Since: 2.8 diff --git a/gtk/gtkfilechooserbutton.c b/gtk/gtkfilechooserbutton.c index 525a54e0f2..7aabd76e13 100644 --- a/gtk/gtkfilechooserbutton.c +++ b/gtk/gtkfilechooserbutton.c @@ -3097,7 +3097,7 @@ gtk_file_chooser_button_set_focus_on_click (GtkFileChooserButton *button, * Returns whether the button grabs focus when it is clicked with the mouse. * See gtk_file_chooser_button_set_focus_on_click(). * - * Return value: %TRUE if the button grabs focus when it is clicked with + * Returns: %TRUE if the button grabs focus when it is clicked with * the mouse. * * Since: 2.10 diff --git a/gtk/gtkfilechooserdialog.c b/gtk/gtkfilechooserdialog.c index 70eea814a9..e67e3e1b14 100644 --- a/gtk/gtkfilechooserdialog.c +++ b/gtk/gtkfilechooserdialog.c @@ -556,7 +556,7 @@ gtk_file_chooser_dialog_new_valist (const gchar *title, * Creates a new #GtkFileChooserDialog. This function is analogous to * gtk_dialog_new_with_buttons(). * - * Return value: a new #GtkFileChooserDialog + * Returns: a new #GtkFileChooserDialog * * Since: 2.4 **/ diff --git a/gtk/gtkfilechooserentry.c b/gtk/gtkfilechooserentry.c index 013947ea02..526895bd44 100644 --- a/gtk/gtkfilechooserentry.c +++ b/gtk/gtkfilechooserentry.c @@ -710,7 +710,7 @@ delete_text_callback (GtkFileChooserEntry *chooser_entry, * which is an entry with completion with respect to a * #GtkFileSystem object. * - * Return value: the newly created #GtkFileChooserEntry + * Returns: the newly created #GtkFileChooserEntry **/ GtkWidget * _gtk_file_chooser_entry_new (gboolean eat_tabs) @@ -764,7 +764,7 @@ _gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry, * be different. If the user has entered unparsable text, or text which * the entry cannot handle, this will return %NULL. * - * Return value: the file for the current folder - you must g_object_unref() + * Returns: the file for the current folder - you must g_object_unref() * the value after use. **/ GFile * @@ -785,7 +785,7 @@ _gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry) * and if a filename path is needed, g_file_get_child_for_display_name() * must be used * - * Return value: the entered filename - this value is owned by the + * Returns: the entered filename - this value is owned by the * chooser entry and must not be modified or freed. **/ const gchar * diff --git a/gtk/gtkfilechooserwidget.c b/gtk/gtkfilechooserwidget.c index 77c2a73a66..8e055e08f3 100644 --- a/gtk/gtkfilechooserwidget.c +++ b/gtk/gtkfilechooserwidget.c @@ -7670,7 +7670,7 @@ gtk_file_chooser_widget_init (GtkFileChooserWidget *impl) * be embedded in custom windows, and it is the same widget that is used by * #GtkFileChooserDialog. * - * Return value: a new #GtkFileChooserWidget + * Returns: a new #GtkFileChooserWidget * * Since: 2.4 **/ diff --git a/gtk/gtkfilefilter.c b/gtk/gtkfilefilter.c index cebc0d119e..6fb533f191 100644 --- a/gtk/gtkfilefilter.c +++ b/gtk/gtkfilefilter.c @@ -352,7 +352,7 @@ gtk_file_filter_buildable_custom_tag_end (GtkBuildable *buildable, * gtk_file_filter_add_pattern (filter, "*"); * ]| * - * Return value: a new #GtkFileFilter + * Returns: a new #GtkFileFilter * * Since: 2.4 **/ @@ -391,7 +391,7 @@ gtk_file_filter_set_name (GtkFileFilter *filter, * * Gets the human-readable name for the filter. See gtk_file_filter_set_name(). * - * Return value: The human-readable name of the filter, + * Returns: The human-readable name of the filter, * or %NULL. This value is owned by GTK+ and must not * be modified or freed. * @@ -540,7 +540,7 @@ gtk_file_filter_add_custom (GtkFileFilter *filter, * is intended principally for use in the implementation of * #GtkFileChooser. * - * Return value: bitfield of flags indicating needed fields when + * Returns: bitfield of flags indicating needed fields when * calling gtk_file_filter_filter() * * Since: 2.4 @@ -565,7 +565,7 @@ gtk_file_filter_get_needed (GtkFileFilter *filter) * is intended principally for use in the implementation of * #GtkFileChooser. * - * Return value: %TRUE if the file should be displayed + * Returns: %TRUE if the file should be displayed * * Since: 2.4 **/ diff --git a/gtk/gtkfilesystemmodel.c b/gtk/gtkfilesystemmodel.c index ff60a98bc3..b9f4d326a3 100644 --- a/gtk/gtkfilesystemmodel.c +++ b/gtk/gtkfilesystemmodel.c @@ -1392,7 +1392,7 @@ _gtk_file_system_model_new_valist (GtkFileSystemModelGetValue get_func, * to the list using _gtk_file_system_model_add_and_query_file() * or _gtk_file_system_model_update_file(). * - * Return value: the newly created #GtkFileSystemModel + * Returns: the newly created #GtkFileSystemModel **/ GtkFileSystemModel * _gtk_file_system_model_new (GtkFileSystemModelGetValue get_func, @@ -1429,7 +1429,7 @@ _gtk_file_system_model_new (GtkFileSystemModelGetValue get_func, * it will also monitor the drectory and update the model's * contents to reflect changes, if the @directory supports monitoring. * - * Return value: the newly created #GtkFileSystemModel + * Returns: the newly created #GtkFileSystemModel **/ GtkFileSystemModel * _gtk_file_system_model_new_for_directory (GFile * dir, @@ -1649,7 +1649,7 @@ _gtk_file_system_model_iter_is_filtered_out (GtkFileSystemModel *model, * Gets the #GFileInfo-struct for a particular row * of @model. * - * Return value: a #GFileInfo-struct. This value + * Returns: a #GFileInfo-struct. This value * is owned by @model and must not be modified or freed. * If you want to keep the information for later use, * you must take a reference, since the #GFileInfo-struct may be @@ -1679,7 +1679,7 @@ _gtk_file_system_model_get_info (GtkFileSystemModel *model, * * Gets the file for a particular row in @model. * - * Return value: the file. This object is owned by @model and + * Returns: the file. This object is owned by @model and * or freed. If you want to save the path for later use, * you must take a ref, since the object may be freed * on later changes to the file system. diff --git a/gtk/gtkflowbox.c b/gtk/gtkflowbox.c index 5e7fb04b97..63c4766ad7 100644 --- a/gtk/gtkflowbox.c +++ b/gtk/gtkflowbox.c @@ -4145,7 +4145,7 @@ gtk_flow_box_set_vadjustment (GtkFlowBox *box, * Returns whether the box is homogeneous (all children are the * same size). See gtk_box_set_homogeneous(). * - * Return value: %TRUE if the box is homogeneous. + * Returns: %TRUE if the box is homogeneous. * * Since: 3.12 */ diff --git a/gtk/gtkfontbutton.c b/gtk/gtkfontbutton.c index 9189281e93..70c024f875 100644 --- a/gtk/gtkfontbutton.c +++ b/gtk/gtkfontbutton.c @@ -854,7 +854,7 @@ gtk_font_button_set_use_size (GtkFontButton *font_button, * * Returns whether the name of the font style will be shown in the label. * - * Return value: whether the font style will be shown in the label. + * Returns: whether the font style will be shown in the label. * * Since: 2.4 **/ @@ -899,7 +899,7 @@ gtk_font_button_set_show_style (GtkFontButton *font_button, * * Returns whether the font size will be shown in the label. * - * Return value: whether the font size will be shown in the label. + * Returns: whether the font size will be shown in the label. * * Since: 2.4 **/ diff --git a/gtk/gtkfontchooser.c b/gtk/gtkfontchooser.c index a2efb33929..c7ac800763 100644 --- a/gtk/gtkfontchooser.c +++ b/gtk/gtkfontchooser.c @@ -136,7 +136,7 @@ gtk_font_chooser_default_init (GtkFontChooserInterface *iface) * * If the selected font is not installed, returns %NULL. * - * Return value: (transfer none): A #PangoFontFamily representing the + * Returns: (transfer none): A #PangoFontFamily representing the * selected font family, or %NULL. The returned object is owned by @fontchooser * and must not be modified or freed. * @@ -159,7 +159,7 @@ gtk_font_chooser_get_font_family (GtkFontChooser *fontchooser) * * If the selected font is not installed, returns %NULL. * - * Return value: (transfer none): A #PangoFontFace representing the + * Returns: (transfer none): A #PangoFontFace representing the * selected font group details, or %NULL. The returned object is owned by * @fontchooser and must not be modified or freed. * @@ -179,7 +179,7 @@ gtk_font_chooser_get_font_face (GtkFontChooser *fontchooser) * * The selected font size. * - * Return value: A n integer representing the selected font size, + * Returns: A n integer representing the selected font size, * or -1 if no font size is selected. * * Since: 3.2 @@ -207,7 +207,7 @@ gtk_font_chooser_get_font_size (GtkFontChooser *fontchooser) * Use pango_font_description_equal() if you want to compare two * font descriptions. * - * Return value: (transfer full) (allow-none): A string with the name + * Returns: (transfer full) (allow-none): A string with the name * of the current font, or %NULL if no font is selected. You must * free this string with g_free(). * @@ -260,7 +260,7 @@ gtk_font_chooser_set_font (GtkFontChooser *fontchooser, * Use pango_font_description_equal() if you want to compare two * font descriptions. * - * Return value: (transfer full) (allow-none): A #PangoFontDescription for the + * Returns: (transfer full) (allow-none): A #PangoFontDescription for the * current font, or %NULL if no font is selected. * * Since: 3.2 @@ -302,7 +302,7 @@ gtk_font_chooser_set_font_desc (GtkFontChooser *fontchooser, * * Gets the text displayed in the preview area. * - * Return value: (transfer full): the text displayed in the + * Returns: (transfer full): the text displayed in the * preview area * * Since: 3.2 @@ -345,7 +345,7 @@ gtk_font_chooser_set_preview_text (GtkFontChooser *fontchooser, * * Returns whether the preview entry is shown or not. * - * Return value: %TRUE if the preview entry is shown + * Returns: %TRUE if the preview entry is shown * or %FALSE if it is hidden. * * Since: 3.2 diff --git a/gtk/gtkfontchooserdialog.c b/gtk/gtkfontchooserdialog.c index 6de69e3db4..2b826407ad 100644 --- a/gtk/gtkfontchooserdialog.c +++ b/gtk/gtkfontchooserdialog.c @@ -177,7 +177,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS * * Creates a new #GtkFontChooserDialog. * - * Return value: a new #GtkFontChooserDialog + * Returns: a new #GtkFontChooserDialog * * Since: 3.2 */ diff --git a/gtk/gtkfontchooserwidget.c b/gtk/gtkfontchooserwidget.c index 8e1a6a4c1e..3918c4bfe8 100644 --- a/gtk/gtkfontchooserwidget.c +++ b/gtk/gtkfontchooserwidget.c @@ -563,7 +563,7 @@ gtk_font_chooser_widget_init (GtkFontChooserWidget *fontchooser) * * Creates a new #GtkFontChooserWidget. * - * Return value: a new #GtkFontChooserWidget + * Returns: a new #GtkFontChooserWidget * * Since: 3.2 */ diff --git a/gtk/gtkframe.c b/gtk/gtkframe.c index 98b4a75d4f..11b761b8e6 100644 --- a/gtk/gtkframe.c +++ b/gtk/gtkframe.c @@ -332,7 +332,7 @@ gtk_frame_get_property (GObject *object, * Creates a new #GtkFrame, with optional label @label. * If @label is %NULL, the label is omitted. * - * Return value: a new #GtkFrame widget + * Returns: a new #GtkFrame widget **/ GtkWidget* gtk_frame_new (const gchar *label) @@ -425,7 +425,7 @@ gtk_frame_set_label (GtkFrame *frame, * for the label widget if a non-%NULL argument was passed * to gtk_frame_new().) * - * Return value: the text in the label, or %NULL if there + * Returns: the text in the label, or %NULL if there * was no label widget or the lable widget was not * a #GtkLabel. This string is owned by GTK+ and * must not be modified or freed. @@ -501,7 +501,7 @@ gtk_frame_set_label_widget (GtkFrame *frame, * Retrieves the label widget for the frame. See * gtk_frame_set_label_widget(). * - * Return value: (transfer none): the label widget, or %NULL if there is none. + * Returns: (transfer none): the label widget, or %NULL if there is none. **/ GtkWidget * gtk_frame_get_label_widget (GtkFrame *frame) @@ -624,7 +624,7 @@ gtk_frame_set_shadow_type (GtkFrame *frame, * Retrieves the shadow type of the frame. See * gtk_frame_set_shadow_type(). * - * Return value: the current shadow type of the frame. + * Returns: the current shadow type of the frame. **/ GtkShadowType gtk_frame_get_shadow_type (GtkFrame *frame) diff --git a/gtk/gtkheaderbar.c b/gtk/gtkheaderbar.c index b87947167f..d38efb3a79 100644 --- a/gtk/gtkheaderbar.c +++ b/gtk/gtkheaderbar.c @@ -1158,7 +1158,7 @@ gtk_header_bar_set_title (GtkHeaderBar *bar, * * Retrieves the title of the header. See gtk_header_bar_set_title(). * - * Return value: the title of the header, or %NULL if none has + * Returns: the title of the header, or %NULL if none has * been set explicitly. The returned string is owned by the widget * and must not be modified or freed. * @@ -1219,7 +1219,7 @@ gtk_header_bar_set_subtitle (GtkHeaderBar *bar, * * Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle(). * - * Return value: the subtitle of the header, or %NULL if none has + * Returns: the subtitle of the header, or %NULL if none has * been set explicitly. The returned string is owned by the widget * and must not be modified or freed. * @@ -1311,7 +1311,7 @@ gtk_header_bar_set_custom_title (GtkHeaderBar *bar, * Retrieves the custom title widget of the header. See * gtk_header_bar_set_custom_title(). * - * Return value: (transfer none): the custom title widget + * Returns: (transfer none): the custom title widget * of the header, or %NULL if none has been set explicitly. * * Since: 3.10 diff --git a/gtk/gtkiconcachevalidator.c b/gtk/gtkiconcachevalidator.c index a4e6947826..81a26e5914 100644 --- a/gtk/gtkiconcachevalidator.c +++ b/gtk/gtkiconcachevalidator.c @@ -378,7 +378,7 @@ check_hash (CacheInfo *info, * be deserialized. The amount of validation can * be controlled with the @flags field. * - * Return value: %TRUE if the cache is valid + * Returns: %TRUE if the cache is valid */ gboolean _gtk_icon_cache_validate (CacheInfo *info) diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c index e17fa3dfcb..c857f5b63e 100644 --- a/gtk/gtkicontheme.c +++ b/gtk/gtkicontheme.c @@ -438,7 +438,7 @@ G_DEFINE_TYPE_WITH_PRIVATE (GtkIconTheme, gtk_icon_theme, G_TYPE_OBJECT) * or gtk_icon_theme_get_for_screen() rather than creating * a new icon theme object for scratch. * - * Return value: the newly created #GtkIconTheme object. + * Returns: the newly created #GtkIconTheme object. * * Since: 2.4 **/ @@ -454,7 +454,7 @@ gtk_icon_theme_new (void) * Gets the icon theme for the default screen. See * gtk_icon_theme_get_for_screen(). * - * Return value: (transfer none): A unique #GtkIconTheme associated with + * Returns: (transfer none): A unique #GtkIconTheme associated with * the default screen. This icon theme is associated with * the screen and can be used as long as the screen * is open. Do not ref or unref it. @@ -480,7 +480,7 @@ gtk_icon_theme_get_default (void) * and setting the screen yourself; by using this function * a single icon theme object will be shared between users. * - * Return value: (transfer none): A unique #GtkIconTheme associated with + * Returns: (transfer none): A unique #GtkIconTheme associated with * the given screen. This icon theme is associated with * the screen and can be used as long as the screen * is open. Do not ref or unref it. @@ -1804,7 +1804,7 @@ choose_icon (GtkIconTheme *icon_theme, * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() * combines these two steps if all you need is the pixbuf.) * - * Return value: (transfer full): a #GtkIconInfo object containing information + * Returns: (transfer full): a #GtkIconInfo object containing information * about the icon, or %NULL if the icon wasn’t found. * * Since: 2.4 @@ -1841,7 +1841,7 @@ gtk_icon_theme_lookup_icon (GtkIconTheme *icon_theme, * gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines * these two steps if all you need is the pixbuf.) * - * Return value: (transfer full): a #GtkIconInfo object containing + * Returns: (transfer full): a #GtkIconInfo object containing * information about the icon, or %NULL if the icon wasn’t found. * * Since: 3.10 @@ -1945,7 +1945,7 @@ gtk_icon_theme_lookup_icon_for_scale (GtkIconTheme *icon_theme, * tries them all in the given order before falling back to * inherited icon themes. * - * Return value: (transfer full): a #GtkIconInfo object containing information + * Returns: (transfer full): a #GtkIconInfo object containing information * about the icon, or %NULL if the icon wasn’t found. * * Since: 2.12 @@ -1983,7 +1983,7 @@ gtk_icon_theme_choose_icon (GtkIconTheme *icon_theme, * tries them all in the given order before falling back to * inherited icon themes. * - * Return value: (transfer full): a #GtkIconInfo object containing information + * Returns: (transfer full): a #GtkIconInfo object containing information * about the icon, or %NULL if the icon wasn’t found. * * Since: 3.10 @@ -2035,7 +2035,7 @@ gtk_icon_theme_error_quark (void) * returned by this function. Otherwise GTK+ may need to keep the old * icon theme loaded, which would be a waste of memory. * - * Return value: (transfer full): the rendered icon; this may be a + * Returns: (transfer full): the rendered icon; this may be a * newly created icon or a new reference to an internal icon, so * you must not modify the icon. Use g_object_unref() to release * your reference to the icon. %NULL if the icon isn’t found. @@ -2084,7 +2084,7 @@ gtk_icon_theme_load_icon (GtkIconTheme *icon_theme, * returned by this function. Otherwise GTK+ may need to keep the old * icon theme loaded, which would be a waste of memory. * - * Return value: (transfer full): the rendered icon; this may be a + * Returns: (transfer full): the rendered icon; this may be a * newly created icon or a new reference to an internal icon, so * you must not modify the icon. Use g_object_unref() to release * your reference to the icon. %NULL if the icon isn’t found. @@ -2146,7 +2146,7 @@ gtk_icon_theme_load_icon_for_scale (GtkIconTheme *icon_theme, * update the icon. This is usually done by connecting to the * GtkWidget::style-set signal. * - * Return value: (transfer full): the rendered icon; this may be a + * Returns: (transfer full): the rendered icon; this may be a * newly created icon or a new reference to an internal icon, so * you must not modify the icon. Use cairo_surface_destroy() to release * your reference to the icon. %NULL if the icon isn’t found. @@ -2195,7 +2195,7 @@ gtk_icon_theme_load_surface (GtkIconTheme *icon_theme, * Checks whether an icon theme includes an icon * for a particular name. * - * Return value: %TRUE if @icon_theme includes an + * Returns: %TRUE if @icon_theme includes an * icon for @icon_name. * * Since: 2.4 @@ -2261,7 +2261,7 @@ add_size (gpointer key, * that the icon is available in a scalable format. The array * is zero-terminated. * - * Return value: (array zero-terminated=1): An newly allocated array + * Returns: (array zero-terminated=1): An newly allocated array * describing the sizes at which the icon is available. The array * should be freed with g_free() when it is no longer needed. * @@ -2376,7 +2376,7 @@ add_key_to_list (gpointer key, * but will typically include such values as “Applications” and * “MimeTypes”. * - * Return value: (element-type utf8) (transfer full): a #GList list + * Returns: (element-type utf8) (transfer full): a #GList list * holding the names of all the icons in the theme. You must first * free each element in the list with g_free(), then free the list * itself with g_list_free(). @@ -2438,7 +2438,7 @@ gtk_icon_theme_list_icons (GtkIconTheme *icon_theme, * Gets the list of contexts available within the current * hierarchy of icon themes * - * Return value: (element-type utf8) (transfer full): a #GList list + * Returns: (element-type utf8) (transfer full): a #GList list * holding the names of all the contexts in the theme. You must first * free each element in the list with g_free(), then free the list * itself with g_list_free(). @@ -2484,7 +2484,7 @@ gtk_icon_theme_list_contexts (GtkIconTheme *icon_theme) * current theme (for instance, to use when presenting * a list of themes to the user.) * - * Return value: the name of an example icon or %NULL. + * Returns: the name of an example icon or %NULL. * Free with g_free(). * * Since: 2.4 @@ -2561,7 +2561,7 @@ rescan_themes (GtkIconTheme *icon_theme) * currently cached information is discarded and will be reloaded * next time @icon_theme is accessed. * - * Return value: %TRUE if the icon theme has changed and needed + * Returns: %TRUE if the icon theme has changed and needed * to be reloaded. * * Since: 2.4 @@ -3368,7 +3368,7 @@ icon_info_new_builtin (BuiltinIcon *icon) * * Make a copy of a #GtkIconInfo. * - * Return value: the new GtkIconInfo + * Returns: the new GtkIconInfo * * Since: 2.4 * @@ -3452,7 +3452,7 @@ gtk_icon_info_class_init (GtkIconInfoClass *klass) * Note that for scaled icons the base size does * not include the base scale. * - * Return value: the base size, or 0, if no base + * Returns: the base size, or 0, if no base * size is known for the icon. * * Since: 2.4 @@ -3474,7 +3474,7 @@ gtk_icon_info_get_base_size (GtkIconInfo *icon_info) * icon drawn for a high-dpi screen with window-scale 2 for a base * size of 32 will be 64 pixels tall and have a base_scale of 2. * - * Return value: the base scale. + * Returns: the base scale. * * Since: 3.10 **/ @@ -3496,7 +3496,7 @@ gtk_icon_info_get_base_scale (GtkIconInfo *icon_info) * no filename if a builtin icon is returned; in this * case, you should use gtk_icon_info_get_builtin_pixbuf(). * - * Return value: (type filename): the filename for the icon, or %NULL + * Returns: (type filename): the filename for the icon, or %NULL * if gtk_icon_info_get_builtin_pixbuf() should be used instead. The * return value is owned by GTK+ and should not be modified or freed. * @@ -3519,7 +3519,7 @@ gtk_icon_info_get_filename (GtkIconInfo *icon_info) * %GTK_ICON_LOOKUP_USE_BUILTIN to * gtk_icon_theme_lookup_icon(). * - * Return value: (transfer none): the built-in image pixbuf, or %NULL. No + * Returns: (transfer none): the built-in image pixbuf, or %NULL. No * extra reference is added to the returned pixbuf, so if * you want to keep it around, you must use g_object_ref(). * The returned image must not be modified. @@ -3545,7 +3545,7 @@ gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info) * the file name and not the file contents for determining this. * This behaviour may change in the future. * - * Return value: %TRUE if the icon is symbolic, %FALSE otherwise. + * Returns: %TRUE if the icon is symbolic, %FALSE otherwise. * * Since: 3.12 **/ @@ -3887,7 +3887,7 @@ proxy_pixbuf_destroy (guchar *pixels, gpointer data) * the #GtkIconInfo. If this flag has been specified, the pixbuf * returned by this function will be scaled to the exact size. * - * Return value: (transfer full): the rendered icon; this may be a newly + * Returns: (transfer full): the rendered icon; this may be a newly * created icon or a new reference to an internal icon, so you must * not modify the icon. Use g_object_unref() to release your reference * to the icon. @@ -3962,7 +3962,7 @@ gtk_icon_info_load_icon (GtkIconInfo *icon_info, * the #GtkIconInfo. If this flag has been specified, the pixbuf * returned by this function will be scaled to the exact size. * - * Return value: (transfer full): the rendered icon; this may be a newly + * Returns: (transfer full): the rendered icon; this may be a newly * created icon or a new reference to an internal icon, so you must * not modify the icon. Use cairo_surface_destroy() to release your reference * to the icon. @@ -4060,7 +4060,7 @@ gtk_icon_info_load_icon_async (GtkIconInfo *icon_info, * * Finishes an async icon load, see gtk_icon_info_load_icon_async(). * - * Return value: (transfer full): the rendered icon; this may be a newly + * Returns: (transfer full): the rendered icon; this may be a newly * created icon or a new reference to an internal icon, so you must * not modify the icon. Use g_object_unref() to release your reference * to the icon. @@ -4339,7 +4339,7 @@ _gtk_icon_info_load_symbolic_internal (GtkIconInfo *icon_info, * See the [Symbolic Icons Specification](http://www.freedesktop.org/wiki/SymbolicIcons) * for more information about symbolic icons. * - * Return value: (transfer full): a #GdkPixbuf representing the loaded icon + * Returns: (transfer full): a #GdkPixbuf representing the loaded icon * * Since: 3.0 **/ @@ -4393,7 +4393,7 @@ gtk_icon_info_load_symbolic (GtkIconInfo *icon_info, * * See gtk_icon_info_load_symbolic() for more details. * - * Return value: (transfer full): a #GdkPixbuf representing the loaded icon + * Returns: (transfer full): a #GdkPixbuf representing the loaded icon * * Since: 3.0 **/ @@ -4624,7 +4624,7 @@ gtk_icon_info_load_symbolic_async (GtkIconInfo *icon_info, * * Finishes an async icon load, see gtk_icon_info_load_symbolic_async(). * - * Return value: (transfer full): the rendered icon; this may be a newly + * Returns: (transfer full): the rendered icon; this may be a newly * created icon or a new reference to an internal icon, so you must * not modify the icon. Use g_object_unref() to release your reference * to the icon. @@ -4753,7 +4753,7 @@ gtk_icon_info_load_symbolic_for_context_async (GtkIconInfo *icon_info, * * Finishes an async icon load, see gtk_icon_info_load_symbolic_for_context_async(). * - * Return value: (transfer full): the rendered icon; this may be a newly + * Returns: (transfer full): the rendered icon; this may be a newly * created icon or a new reference to an internal icon, so you must * not modify the icon. Use g_object_unref() to release your reference * to the icon. @@ -4798,7 +4798,7 @@ color_to_rgba (GdkColor *color, GdkRGBA *rgba) * * See gtk_icon_info_load_symbolic() for more details. * - * Return value: (transfer full): a #GdkPixbuf representing the loaded icon + * Returns: (transfer full): a #GdkPixbuf representing the loaded icon * * Since: 3.0 * @@ -4925,7 +4925,7 @@ icon_info_scale_point (GtkIconInfo *icon_info, * See gtk_icon_info_set_raw_coordinates() for further * information about the coordinate system. * - * Return value: %TRUE if the icon has an embedded rectangle + * Returns: %TRUE if the icon has an embedded rectangle * * Since: 2.4 **/ @@ -4973,7 +4973,7 @@ gtk_icon_info_get_embedded_rect (GtkIconInfo *icon_info, * is a location in the icon that can be used as anchor points for attaching * emblems or overlays to the icon. * - * Return value: %TRUE if there are any attach points for the icon. + * Returns: %TRUE if there are any attach points for the icon. * * Since: 2.4 **/ @@ -5024,7 +5024,7 @@ gtk_icon_info_get_attach_points (GtkIconInfo *icon_info, * string to be used in place of the icon name in a user * visible context like a list of icons. * - * Return value: the display name for the icon or %NULL, if + * Returns: the display name for the icon or %NULL, if * the icon doesn’t have a specified display name. This value * is owned @icon_info and must not be modified or free. * @@ -5187,7 +5187,7 @@ find_builtin_icon (const gchar *icon_name, * The icon can then be rendered into a pixbuf using * gtk_icon_info_load_icon(). * - * Return value: (transfer full): a #GtkIconInfo containing + * Returns: (transfer full): a #GtkIconInfo containing * information about the icon, or %NULL if the icon * wasn’t found. Unref with g_object_unref() * @@ -5217,7 +5217,7 @@ gtk_icon_theme_lookup_by_gicon (GtkIconTheme *icon_theme, * The icon can then be rendered into a pixbuf using * gtk_icon_info_load_icon(). * - * Return value: (transfer full): a #GtkIconInfo containing + * Returns: (transfer full): a #GtkIconInfo containing * information about the icon, or %NULL if the icon * wasn’t found. Unref with g_object_unref() * @@ -5341,7 +5341,7 @@ gtk_icon_theme_lookup_by_gicon_for_scale (GtkIconTheme *icon_theme, * * Creates a #GtkIconInfo for a #GdkPixbuf. * - * Return value: (transfer full): a #GtkIconInfo + * Returns: (transfer full): a #GtkIconInfo * * Since: 2.14 */ diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c index 3ad9259088..4cd36b912d 100644 --- a/gtk/gtkiconview.c +++ b/gtk/gtkiconview.c @@ -2245,7 +2245,7 @@ gtk_icon_view_set_cursor (GtkIconView *icon_view, * * The returned #GtkTreePath must be freed with gtk_tree_path_free(). * - * Return value: %TRUE if the cursor is set. + * Returns: %TRUE if the cursor is set. * * Since: 2.8 **/ @@ -4365,7 +4365,7 @@ _gtk_icon_view_set_cell_data (GtkIconView *icon_view, * * Creates a new #GtkIconView widget * - * Return value: A newly created #GtkIconView widget + * Returns: A newly created #GtkIconView widget * * Since: 2.6 **/ @@ -4382,7 +4382,7 @@ gtk_icon_view_new (void) * Creates a new #GtkIconView widget using the * specified @area to layout cells inside the icons. * - * Return value: A newly created #GtkIconView widget + * Returns: A newly created #GtkIconView widget * * Since: 3.0 **/ @@ -4398,7 +4398,7 @@ gtk_icon_view_new_with_area (GtkCellArea *area) * * Creates a new #GtkIconView widget with the model @model. * - * Return value: A newly created #GtkIconView widget. + * Returns: A newly created #GtkIconView widget. * * Since: 2.6 **/ @@ -4455,7 +4455,7 @@ gtk_icon_view_convert_widget_to_bin_window_coords (GtkIconView *icon_view, * See gtk_icon_view_convert_widget_to_bin_window_coords() for converting * widget coordinates to bin_window coordinates. * - * Return value: The #GtkTreePath corresponding to the icon or %NULL + * Returns: The #GtkTreePath corresponding to the icon or %NULL * if no icon exists at that position. * * Since: 2.6 @@ -4496,7 +4496,7 @@ gtk_icon_view_get_path_at_pos (GtkIconView *icon_view, * See gtk_icon_view_convert_widget_to_bin_window_coords() for converting * widget coordinates to bin_window coordinates. * - * Return value: %TRUE if an item exists at the specified position + * Returns: %TRUE if an item exists at the specified position * * Since: 2.8 **/ @@ -4540,7 +4540,7 @@ gtk_icon_view_get_item_at_pos (GtkIconView *icon_view, * * This function is only valid if @icon_view is realized. * - * Return value: %FALSE if there is no such item, %TRUE otherwise + * Returns: %FALSE if there is no such item, %TRUE otherwise * * Since: 3.6 */ @@ -4670,7 +4670,7 @@ gtk_icon_view_set_tooltip_cell (GtkIconView *icon_view, * that row and the corresponding model. @x and @y will always be converted * to be relative to @icon_view’s bin_window if @keyboard_tooltip is %FALSE. * - * Return value: whether or not the given tooltip context points to a item + * Returns: whether or not the given tooltip context points to a item * * Since: 2.12 */ @@ -4813,7 +4813,7 @@ gtk_icon_view_set_tooltip_column (GtkIconView *icon_view, * Returns the column of @icon_view’s model which is being used for * displaying tooltips on @icon_view’s rows. * - * Return value: the index of the tooltip column that is currently being + * Returns: the index of the tooltip column that is currently being * used, or -1 if this is disabled. * * Since: 2.12 @@ -4838,7 +4838,7 @@ gtk_icon_view_get_tooltip_column (GtkIconView *icon_view) * * Both paths should be freed with gtk_tree_path_free() after use. * - * Return value: %TRUE, if valid paths were placed in @start_path and @end_path + * Returns: %TRUE, if valid paths were placed in @start_path and @end_path * * Since: 2.8 **/ @@ -4951,7 +4951,7 @@ gtk_icon_view_set_selection_mode (GtkIconView *icon_view, * * Gets the selection mode of the @icon_view. * - * Return value: the current selection mode + * Returns: the current selection mode * * Since: 2.6 **/ @@ -5096,7 +5096,7 @@ gtk_icon_view_set_model (GtkIconView *icon_view, * Returns the model the #GtkIconView is based on. Returns %NULL if the * model is unset. * - * Return value: (transfer none): A #GtkTreeModel, or %NULL if none is + * Returns: (transfer none): A #GtkTreeModel, or %NULL if none is * currently being used. * * Since: 2.6 @@ -5460,7 +5460,7 @@ gtk_icon_view_unselect_path (GtkIconView *icon_view, * g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); * ]| * - * Return value: (element-type GtkTreePath) (transfer full): A #GList containing a #GtkTreePath for each selected row. + * Returns: (element-type GtkTreePath) (transfer full): A #GList containing a #GtkTreePath for each selected row. * * Since: 2.6 **/ @@ -5555,7 +5555,7 @@ gtk_icon_view_unselect_all (GtkIconView *icon_view) * Returns %TRUE if the icon pointed to by @path is currently * selected. If @path does not point to a valid location, %FALSE is returned. * - * Return value: %TRUE if @path is selected. + * Returns: %TRUE if @path is selected. * * Since: 2.6 **/ @@ -5704,7 +5704,7 @@ gtk_icon_view_set_item_orientation (GtkIconView *icon_view, * Returns the value of the ::item-orientation property which determines * whether the labels are drawn beside the icons instead of below. * - * Return value: the relative position of texts and icons + * Returns: the relative position of texts and icons * * Since: 2.6 **/ @@ -5754,7 +5754,7 @@ gtk_icon_view_set_columns (GtkIconView *icon_view, * * Returns the value of the ::columns property. * - * Return value: the number of columns, or -1 + * Returns: the number of columns, or -1 * * Since: 2.6 */ @@ -5804,7 +5804,7 @@ gtk_icon_view_set_item_width (GtkIconView *icon_view, * * Returns the value of the ::item-width property. * - * Return value: the width of a single item, or -1 + * Returns: the width of a single item, or -1 * * Since: 2.6 */ @@ -5853,7 +5853,7 @@ gtk_icon_view_set_spacing (GtkIconView *icon_view, * * Returns the value of the ::spacing property. * - * Return value: the space between cells + * Returns: the space between cells * * Since: 2.6 */ @@ -5900,7 +5900,7 @@ gtk_icon_view_set_row_spacing (GtkIconView *icon_view, * * Returns the value of the ::row-spacing property. * - * Return value: the space between rows + * Returns: the space between rows * * Since: 2.6 */ @@ -5947,7 +5947,7 @@ gtk_icon_view_set_column_spacing (GtkIconView *icon_view, * * Returns the value of the ::column-spacing property. * - * Return value: the space between columns + * Returns: the space between columns * * Since: 2.6 */ @@ -5995,7 +5995,7 @@ gtk_icon_view_set_margin (GtkIconView *icon_view, * * Returns the value of the ::margin property. * - * Return value: the space at the borders + * Returns: the space at the borders * * Since: 2.6 */ @@ -6042,7 +6042,7 @@ gtk_icon_view_set_item_padding (GtkIconView *icon_view, * * Returns the value of the ::item-padding property. * - * Return value: the padding around items + * Returns: the padding around items * * Since: 2.18 */ @@ -7047,7 +7047,7 @@ gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view, * * Determines the destination item for a given position. * - * Return value: whether there is an item at the given position. + * Returns: whether there is an item at the given position. * * Since: 2.8 **/ @@ -7109,7 +7109,7 @@ gtk_icon_view_get_dest_item_at_pos (GtkIconView *icon_view, * Creates a #cairo_surface_t representation of the item at @path. * This image is used for a drag icon. * - * Return value: (transfer full): a newly-allocated surface of the drag icon. + * Returns: (transfer full): a newly-allocated surface of the drag icon. * * Since: 2.8 **/ @@ -7174,7 +7174,7 @@ gtk_icon_view_create_drag_icon (GtkIconView *icon_view, * Retrieves whether the user can reorder the list via drag-and-drop. * See gtk_icon_view_set_reorderable(). * - * Return value: %TRUE if the list can be reordered. + * Returns: %TRUE if the list can be reordered. * * Since: 2.8 **/ @@ -7276,7 +7276,7 @@ gtk_icon_view_set_activate_on_single_click (GtkIconView *icon_view, * * Gets the setting set by gtk_icon_view_set_activate_on_single_click(). * - * Return value: %TRUE if item-activated will be emitted on a single click + * Returns: %TRUE if item-activated will be emitted on a single click * * Since: 3.8 **/ diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c index e6e0062e5b..467456e3f4 100644 --- a/gtk/gtkimage.c +++ b/gtk/gtkimage.c @@ -564,7 +564,7 @@ gtk_image_get_property (GObject *object, * image is not defined, it will be whatever is appropriate for * displaying the file. * - * Return value: a new #GtkImage + * Returns: a new #GtkImage **/ GtkWidget* gtk_image_new_from_file (const gchar *filename) @@ -599,7 +599,7 @@ gtk_image_new_from_file (const gchar *filename) * image is not defined, it will be whatever is appropriate for * displaying the file. * - * Return value: a new #GtkImage + * Returns: a new #GtkImage * * Since: 3.4 **/ @@ -628,7 +628,7 @@ gtk_image_new_from_resource (const gchar *resource_path) * #GtkImage created will not react to state changes. Should you want that, * you should use gtk_image_new_from_icon_name(). * - * Return value: a new #GtkImage + * Returns: a new #GtkImage **/ GtkWidget* gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf) @@ -651,7 +651,7 @@ gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf) * surface; you still need to unref it if you own references. * #GtkImage will add its own reference rather than adopting yours. * - * Return value: a new #GtkImage + * Returns: a new #GtkImage **/ GtkWidget* gtk_image_new_from_surface (cairo_surface_t *surface) @@ -677,7 +677,7 @@ gtk_image_new_from_surface (cairo_surface_t *surface) * You can register your own stock icon names, see * gtk_icon_factory_add_default() and gtk_icon_factory_add(). * - * Return value: a new #GtkImage displaying the stock icon + * Returns: a new #GtkImage displaying the stock icon * * Deprecated: 3.10: Use gtk_image_new_from_icon_name() instead. **/ @@ -713,7 +713,7 @@ gtk_image_new_from_stock (const gchar *stock_id, * icon set; you still need to unref it if you own references. * #GtkImage will add its own reference rather than adopting yours. * - * Return value: a new #GtkImage + * Returns: a new #GtkImage * * Deprecated: 3.10: Use gtk_image_new_from_icon_name() instead. **/ @@ -748,7 +748,7 @@ gtk_image_new_from_icon_set (GtkIconSet *icon_set, * keep in mind that the animation will only be shown if the main loop * is not busy with something that has a higher priority. * - * Return value: a new #GtkImage widget + * Returns: a new #GtkImage widget **/ GtkWidget* gtk_image_new_from_animation (GdkPixbufAnimation *animation) @@ -774,7 +774,7 @@ gtk_image_new_from_animation (GdkPixbufAnimation *animation) * displayed instead. If the current icon theme is changed, the icon * will be updated appropriately. * - * Return value: a new #GtkImage displaying the themed icon + * Returns: a new #GtkImage displaying the themed icon * * Since: 2.6 **/ @@ -801,7 +801,7 @@ gtk_image_new_from_icon_name (const gchar *icon_name, * displayed instead. If the current icon theme is changed, the icon * will be updated appropriately. * - * Return value: a new #GtkImage displaying the themed icon + * Returns: a new #GtkImage displaying the themed icon * * Since: 2.14 **/ @@ -1206,7 +1206,7 @@ gtk_image_set_from_surface (GtkImage *image, * to store image data. If the #GtkImage has no image data, * the return value will be %GTK_IMAGE_EMPTY. * - * Return value: image representation being used + * Returns: image representation being used **/ GtkImageType gtk_image_get_storage_type (GtkImage *image) @@ -1226,7 +1226,7 @@ gtk_image_get_storage_type (GtkImage *image) * The caller of this function does not own a reference to the * returned pixbuf. * - * Return value: (transfer none): the displayed pixbuf, or %NULL if + * Returns: (transfer none): the displayed pixbuf, or %NULL if * the image is empty **/ GdkPixbuf* @@ -1313,7 +1313,7 @@ gtk_image_get_icon_set (GtkImage *image, * The caller of this function does not own a reference to the * returned animation. * - * Return value: (transfer none): the displayed animation, or %NULL if + * Returns: (transfer none): the displayed animation, or %NULL if * the image is empty **/ GdkPixbufAnimation* @@ -1401,7 +1401,7 @@ gtk_image_get_gicon (GtkImage *image, * * Creates a new empty #GtkImage widget. * - * Return value: a newly created #GtkImage widget. + * Returns: a newly created #GtkImage widget. **/ GtkWidget* gtk_image_new (void) diff --git a/gtk/gtkimcontext.c b/gtk/gtkimcontext.c index a82fe5e308..5ef5854824 100644 --- a/gtk/gtkimcontext.c +++ b/gtk/gtkimcontext.c @@ -292,7 +292,7 @@ gtk_im_context_class_init (GtkIMContextClass *klass) * the input method surrounding context by calling the * gtk_im_context_set_surrounding() method. * - * Return value: %TRUE if the signal was handled. + * Returns: %TRUE if the signal was handled. */ im_context_signals[RETRIEVE_SURROUNDING] = g_signal_new (I_("retrieve-surrounding"), @@ -313,7 +313,7 @@ gtk_im_context_class_init (GtkIMContextClass *klass) * The ::delete-surrounding signal is emitted when the input method * needs to delete all or part of the context surrounding the cursor. * - * Return value: %TRUE if the signal was handled. + * Returns: %TRUE if the signal was handled. */ im_context_signals[DELETE_SURROUNDING] = g_signal_new (I_("delete-surrounding"), @@ -500,7 +500,7 @@ gtk_im_context_get_preedit_string (GtkIMContext *context, * events. If this function returns %TRUE, then no further processing * should be done for this key event. * - * Return value: %TRUE if the input method handled the key event. + * Returns: %TRUE if the input method handled the key event. * **/ gboolean @@ -684,7 +684,7 @@ gtk_im_context_set_surrounding (GtkIMContext *context, * for a widget to respond to the ::retrieve_surrounding signal, so input * methods must be prepared to function without context. * - * Return value: %TRUE if surrounding text was provided; in this case + * Returns: %TRUE if surrounding text was provided; in this case * you must free the result stored in *text. **/ gboolean @@ -735,7 +735,7 @@ gtk_im_context_get_surrounding (GtkIMContext *context, * subsitutions in the existing text in response to new input. It is * not useful for applications. * - * Return value: %TRUE if the signal was handled. + * Returns: %TRUE if the signal was handled. **/ gboolean gtk_im_context_delete_surrounding (GtkIMContext *context, diff --git a/gtk/gtkimmodule.c b/gtk/gtkimmodule.c index 329546e13c..2122b10dce 100644 --- a/gtk/gtkimmodule.c +++ b/gtk/gtkimmodule.c @@ -599,7 +599,7 @@ _gtk_im_module_list (const GtkIMContextInfo ***contexts, * Create an IM context of a type specified by the string * ID @context_id. * - * Return value: a newly created input context of or @context_id, or + * Returns: a newly created input context of or @context_id, or * if that could not be created, a newly created GtkIMContextSimple. */ GtkIMContext * @@ -777,7 +777,7 @@ get_current_input_language (void) * Return the context_id of the best IM context type * for the given window. * - * Return value: the context ID (will never be %NULL) + * Returns: the context ID (will never be %NULL) */ const gchar * _gtk_im_module_get_default_context_id (GdkWindow *client_window) diff --git a/gtk/gtkinvisible.c b/gtk/gtkinvisible.c index 788f545795..628b2d2d55 100644 --- a/gtk/gtkinvisible.c +++ b/gtk/gtkinvisible.c @@ -143,7 +143,7 @@ gtk_invisible_destroy (GtkWidget *widget) * * Creates a new #GtkInvisible object for a specified screen * - * Return value: a newly created #GtkInvisible object + * Returns: a newly created #GtkInvisible object * * Since: 2.2 **/ @@ -160,7 +160,7 @@ gtk_invisible_new_for_screen (GdkScreen *screen) * * Creates a new #GtkInvisible. * - * Return value: a new #GtkInvisible. + * Returns: a new #GtkInvisible. **/ GtkWidget* gtk_invisible_new (void) @@ -217,7 +217,7 @@ gtk_invisible_set_screen (GtkInvisible *invisible, * * Returns the #GdkScreen object associated with @invisible * - * Return value: (transfer none): the associated #GdkScreen. + * Returns: (transfer none): the associated #GdkScreen. * * Since: 2.2 **/ diff --git a/gtk/gtkkeyhash.c b/gtk/gtkkeyhash.c index a67f2c40ac..9d516183be 100644 --- a/gtk/gtkkeyhash.c +++ b/gtk/gtkkeyhash.c @@ -119,7 +119,7 @@ key_hash_keys_changed (GdkKeymap *keymap, * * Create a new key hash object for doing binding resolution. * - * Return value: the newly created object. Free with _gtk_key_hash_free(). + * Returns: the newly created object. Free with _gtk_key_hash_free(). **/ GtkKeyHash * _gtk_key_hash_new (GdkKeymap *keymap, @@ -373,7 +373,7 @@ keyval_in_group (GdkKeymap *keymap, * This means that fuzzy matches won’t be considered if their keyval is * present in the current group. * - * Return value: A newly-allocated #GSList of matching entries. + * Returns: A newly-allocated #GSList of matching entries. * Free with g_slist_free() when no longer needed. */ GSList * @@ -534,7 +534,7 @@ _gtk_key_hash_lookup (GtkKeyHash *key_hash, * available. The results are sorted so that entries with less * modifiers come before entries with more modifiers. * - * Return value: A #GSList of all matching entries. + * Returns: A #GSList of all matching entries. **/ GSList * _gtk_key_hash_lookup_keyval (GtkKeyHash *key_hash, diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c index fbb0d87b5d..58580346a0 100644 --- a/gtk/gtklabel.c +++ b/gtk/gtklabel.c @@ -1601,7 +1601,7 @@ gtk_label_buildable_custom_finished (GtkBuildable *buildable, * Creates a new label with the given text inside it. You can * pass %NULL to get an empty label widget. * - * Return value: the new #GtkLabel + * Returns: the new #GtkLabel **/ GtkWidget* gtk_label_new (const gchar *str) @@ -1636,7 +1636,7 @@ gtk_label_new (const gchar *str) * the button or menu item will automatically become the mnemonic widget * and be activated by the mnemonic. * - * Return value: the new #GtkLabel + * Returns: the new #GtkLabel **/ GtkWidget* gtk_label_new_with_mnemonic (const gchar *str) @@ -1953,7 +1953,7 @@ gtk_label_set_mnemonic_widget (GtkLabel *label, * Retrieves the target of the mnemonic (keyboard shortcut) of this * label. See gtk_label_set_mnemonic_widget(). * - * Return value: (transfer none): the target of the label’s mnemonic, + * Returns: (transfer none): the target of the label’s mnemonic, * or %NULL if none has been set and the default algorithm will be used. **/ GtkWidget * @@ -2175,7 +2175,7 @@ gtk_label_set_attributes (GtkLabel *label, * effective attributes for the label, use * pango_layout_get_attribute (gtk_label_get_layout (label)). * - * Return value: (transfer none): the attribute list, or %NULL + * Returns: (transfer none): the attribute list, or %NULL * if none was set. **/ PangoAttrList * @@ -2218,7 +2218,7 @@ gtk_label_set_label (GtkLabel *label, * underlines indicating mnemonics and Pango markup. (See * gtk_label_get_text()). * - * Return value: the text of the label widget. This string is + * Returns: the text of the label widget. This string is * owned by the widget and must not be modified or freed. **/ const gchar * @@ -2670,7 +2670,7 @@ gtk_label_set_markup_with_mnemonic (GtkLabel *label, * screen. This does not include any embedded underlines * indicating mnemonics or Pango markup. (See gtk_label_get_label()) * - * Return value: the text in the label widget. This is the internal + * Returns: the text in the label widget. This is the internal * string used by the label, and must not be modified. **/ const gchar * @@ -2830,7 +2830,7 @@ gtk_label_set_justify (GtkLabel *label, * * Returns the justification of the label. See gtk_label_set_justify(). * - * Return value: #GtkJustification + * Returns: #GtkJustification **/ GtkJustification gtk_label_get_justify (GtkLabel *label) @@ -2879,7 +2879,7 @@ gtk_label_set_ellipsize (GtkLabel *label, * * Returns the ellipsizing position of the label. See gtk_label_set_ellipsize(). * - * Return value: #PangoEllipsizeMode + * Returns: #PangoEllipsizeMode * * Since: 2.6 **/ @@ -2925,7 +2925,7 @@ gtk_label_set_width_chars (GtkLabel *label, * Retrieves the desired width of @label, in characters. See * gtk_label_set_width_chars(). * - * Return value: the width of the label in characters. + * Returns: the width of the label in characters. * * Since: 2.6 **/ @@ -2972,7 +2972,7 @@ gtk_label_set_max_width_chars (GtkLabel *label, * Retrieves the desired maximum width of @label, in characters. See * gtk_label_set_width_chars(). * - * Return value: the maximum width of the label in characters. + * Returns: the maximum width of the label in characters. * * Since: 2.6 **/ @@ -3028,7 +3028,7 @@ gtk_label_set_line_wrap (GtkLabel *label, * Returns whether lines in the label are automatically wrapped. * See gtk_label_set_line_wrap(). * - * Return value: %TRUE if the lines of the label are automatically wrapped. + * Returns: %TRUE if the lines of the label are automatically wrapped. */ gboolean gtk_label_get_line_wrap (GtkLabel *label) @@ -3074,7 +3074,7 @@ gtk_label_set_line_wrap_mode (GtkLabel *label, * * Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode(). * - * Return value: %TRUE if the lines of the label are automatically wrapped. + * Returns: %TRUE if the lines of the label are automatically wrapped. * * Since: 2.10 */ @@ -5203,7 +5203,7 @@ gtk_label_set_selectable (GtkLabel *label, * * Gets the value set by gtk_label_set_selectable(). * - * Return value: %TRUE if the user can copy text from the label + * Returns: %TRUE if the user can copy text from the label **/ gboolean gtk_label_get_selectable (GtkLabel *label) @@ -5265,7 +5265,7 @@ gtk_label_set_angle (GtkLabel *label, * Gets the angle of rotation for the label. See * gtk_label_set_angle(). * - * Return value: the angle of rotation for the label + * Returns: the angle of rotation for the label * * Since: 2.6 **/ @@ -5460,7 +5460,7 @@ gtk_label_select_region (GtkLabel *label, * Gets the selected range of characters in the label, returning %TRUE * if there’s a selection. * - * Return value: %TRUE if selection is non-empty + * Returns: %TRUE if selection is non-empty **/ gboolean gtk_label_get_selection_bounds (GtkLabel *label, @@ -5534,7 +5534,7 @@ gtk_label_get_selection_bounds (GtkLabel *label, * freed by the caller. The @label is free to recreate its layout at * any time, so it should be considered read-only. * - * Return value: (transfer none): the #PangoLayout for this label + * Returns: (transfer none): the #PangoLayout for this label **/ PangoLayout* gtk_label_get_layout (GtkLabel *label) @@ -5608,7 +5608,7 @@ gtk_label_set_use_markup (GtkLabel *label, * the [Pango text markup language][PangoMarkupFormat]. * See gtk_label_set_use_markup (). * - * Return value: %TRUE if the label’s text will be parsed for markup. + * Returns: %TRUE if the label’s text will be parsed for markup. **/ gboolean gtk_label_get_use_markup (GtkLabel *label) @@ -5647,7 +5647,7 @@ gtk_label_set_use_underline (GtkLabel *label, * Returns whether an embedded underline in the label indicates a * mnemonic. See gtk_label_set_use_underline(). * - * Return value: %TRUE whether an embedded underline in the label indicates + * Returns: %TRUE whether an embedded underline in the label indicates * the mnemonic accelerator keys. **/ gboolean @@ -5696,7 +5696,7 @@ gtk_label_set_single_line_mode (GtkLabel *label, * * Returns whether the label is in single line mode. * - * Return value: %TRUE when the label is in single line mode. + * Returns: %TRUE when the label is in single line mode. * * Since: 2.6 **/ diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c index 176f626716..30e551a600 100644 --- a/gtk/gtklayout.c +++ b/gtk/gtklayout.c @@ -175,7 +175,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkLayout, gtk_layout, GTK_TYPE_CONTAINER, * you’d like the layout to use for scrolling, pass %NULL for * @hadjustment and @vadjustment. * - * Return value: a new #GtkLayout + * Returns: a new #GtkLayout **/ GtkWidget* @@ -198,7 +198,7 @@ gtk_layout_new (GtkAdjustment *hadjustment, * * Retrieve the bin window of the layout used for drawing operations. * - * Return value: (transfer none): a #GdkWindow + * Returns: (transfer none): a #GdkWindow * * Since: 2.14 **/ @@ -221,7 +221,7 @@ gtk_layout_get_bin_window (GtkLayout *layout) * * See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. * - * Return value: (transfer none): horizontal scroll adjustment + * Returns: (transfer none): horizontal scroll adjustment * * Deprecated: 3.0: Use gtk_scrollable_get_hadjustment() **/ @@ -243,7 +243,7 @@ gtk_layout_get_hadjustment (GtkLayout *layout) * * See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details. * - * Return value: (transfer none): vertical scroll adjustment + * Returns: (transfer none): vertical scroll adjustment * * Deprecated: 3.0: Use gtk_scrollable_get_vadjustment() **/ diff --git a/gtk/gtklevelbar.c b/gtk/gtklevelbar.c index c7c143619f..1af260bdc2 100644 --- a/gtk/gtklevelbar.c +++ b/gtk/gtklevelbar.c @@ -1295,7 +1295,7 @@ gtk_level_bar_set_mode (GtkLevelBar *self, * * Return the value of the #GtkLevelBar:inverted property. * - * Return value: %TRUE if the level bar is inverted + * Returns: %TRUE if the level bar is inverted * * Since: 3.8 */ diff --git a/gtk/gtklinkbutton.c b/gtk/gtklinkbutton.c index 44d7ce2a70..11b887fb7e 100644 --- a/gtk/gtklinkbutton.c +++ b/gtk/gtklinkbutton.c @@ -573,7 +573,7 @@ gtk_link_button_drag_data_get_cb (GtkWidget *widget, * * Creates a new #GtkLinkButton with the URI as its text. * - * Return value: a new link button widget. + * Returns: a new link button widget. * * Since: 2.10 */ @@ -623,7 +623,7 @@ gtk_link_button_new (const gchar *uri) * * Creates a new #GtkLinkButton containing a label. * - * Return value: (transfer none): a new link button widget. + * Returns: (transfer none): a new link button widget. * * Since: 2.10 */ @@ -708,7 +708,7 @@ gtk_link_button_set_uri (GtkLinkButton *link_button, * * Retrieves the URI set using gtk_link_button_set_uri(). * - * Return value: a valid URI. The returned string is owned by the link button + * Returns: a valid URI. The returned string is owned by the link button * and should not be modified or freed. * * Since: 2.10 @@ -768,7 +768,7 @@ gtk_link_button_set_visited (GtkLinkButton *link_button, * * The state may also be changed using gtk_link_button_set_visited(). * - * Return value: %TRUE if the link has been visited, %FALSE otherwise + * Returns: %TRUE if the link has been visited, %FALSE otherwise * * Since: 2.14 */ diff --git a/gtk/gtklistbox.c b/gtk/gtklistbox.c index 941a2b752a..c4bc26cb7c 100644 --- a/gtk/gtklistbox.c +++ b/gtk/gtklistbox.c @@ -471,7 +471,7 @@ gtk_list_box_class_init (GtkListBoxClass *klass) * * Gets the selected row. * - * Return value: (transfer none): the selected #GtkWidget + * Returns: (transfer none): the selected #GtkWidget * * Since: 3.10 */ @@ -497,7 +497,7 @@ gtk_list_box_get_selected_row (GtkListBox *list_box) * * Gets the n:th child in the list (not counting headers). * - * Return value: (transfer none): the child #GtkWidget + * Returns: (transfer none): the child #GtkWidget * * Since: 3.10 */ @@ -526,7 +526,7 @@ gtk_list_box_get_row_at_index (GtkListBox *list_box, * * Gets the row at the @y position. * - * Return value: (transfer none): the row + * Returns: (transfer none): the row * * Since: 3.10 */ @@ -657,7 +657,7 @@ gtk_list_box_set_adjustment (GtkListBox *list_box, * Gets the adjustment (if any) that the widget uses to * for vertical scrolling. * - * Return value: (transfer none): the adjustment + * Returns: (transfer none): the adjustment * * Since: 3.10 */ @@ -2744,7 +2744,7 @@ gtk_list_box_row_changed (GtkListBoxRow *row) * in a #GtkListBoxUpdateHeaderFunc to see if there is a header * set already, and if so to update the state of it. * - * Return value: (transfer none): the current header, or %NULL if none + * Returns: (transfer none): the current header, or %NULL if none * * Since: 3.10 */ diff --git a/gtk/gtkliststore.c b/gtk/gtkliststore.c index fcb1300b74..b730e64373 100644 --- a/gtk/gtkliststore.c +++ b/gtk/gtkliststore.c @@ -409,7 +409,7 @@ iter_is_valid (GtkTreeIter *iter, * GDK_TYPE_PIXBUF);` will create a new #GtkListStore with three columns, of type * int, string and #GdkPixbuf respectively. * - * Return value: a new #GtkListStore + * Returns: a new #GtkListStore */ GtkListStore * gtk_list_store_new (gint n_columns, @@ -454,7 +454,7 @@ gtk_list_store_new (gint n_columns, * * Non-vararg creation function. Used primarily by language bindings. * - * Return value: (transfer full): a new #GtkListStore + * Returns: (transfer full): a new #GtkListStore **/ GtkListStore * gtk_list_store_newv (gint n_columns, @@ -1189,7 +1189,7 @@ gtk_list_store_set (GtkListStore *list_store, * @iter is set to be the next valid row, or invalidated if it pointed * to the last row in @list_store. * - * Return value: %TRUE if @iter is valid, %FALSE if not. + * Returns: %TRUE if @iter is valid, %FALSE if not. **/ gboolean gtk_list_store_remove (GtkListStore *list_store, @@ -1444,7 +1444,7 @@ gtk_list_store_clear (GtkListStore *list_store) * * Checks if the given iter is a valid iter for this #GtkListStore. * - * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid. + * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. * * Since: 2.2 **/ diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c index 684e152e7c..c3367e1af4 100644 --- a/gtk/gtkmain.c +++ b/gtk/gtkmain.c @@ -307,7 +307,7 @@ gtk_get_interface_age (void) * old version of gtk_check_version(), but still get loaded * into an application using a newer version of GTK+. * - * Return value: %NULL if the GTK+ library is compatible with the + * Returns: %NULL if the GTK+ library is compatible with the * given version, or a string describing the version mismatch. * The returned string is owned by GTK+ and should not be modified * or freed. @@ -914,7 +914,7 @@ gtk_init_with_args (gint *argc, * There is no need to call this function explicitly if you are using * gtk_init(), or gtk_init_check(). * - * Return value: %TRUE if initialization succeeded, otherwise %FALSE + * Returns: %TRUE if initialization succeeded, otherwise %FALSE */ gboolean gtk_parse_args (int *argc, @@ -969,7 +969,7 @@ gtk_parse_args (int *argc, * communication with the user - for example a curses or command line * interface. * - * Return value: %TRUE if the windowing system has been successfully + * Returns: %TRUE if the windowing system has been successfully * initialized, %FALSE otherwise */ gboolean @@ -1159,7 +1159,7 @@ gtk_get_locale_direction (void) * This function is equivalent to pango_language_get_default(). * See that function for details. * - * Return value: the default language as a #PangoLanguage, + * Returns: the default language as a #PangoLanguage, * must not be freed */ PangoLanguage * @@ -2085,7 +2085,7 @@ gtk_grab_add (GtkWidget *widget) * * Queries the current grab of the default window group. * - * Return value: (transfer none): The widget which currently + * Returns: (transfer none): The widget which currently * has the grab or %NULL if no grab is active */ GtkWidget* @@ -2287,7 +2287,7 @@ gtk_invoke_key_snoopers (GtkWidget *grab_widget, * the current event will be the #GdkEventButton that triggered * the ::clicked signal. * - * Return value: (transfer full): a copy of the current event, or + * Returns: (transfer full): a copy of the current event, or * %NULL if there is no current event. The returned event must be * freed with gdk_event_free(). */ @@ -2306,7 +2306,7 @@ gtk_get_current_event (void) * If there is a current event and it has a timestamp, * return that timestamp, otherwise return %GDK_CURRENT_TIME. * - * Return value: the timestamp from the current event, + * Returns: the timestamp from the current event, * or %GDK_CURRENT_TIME. */ guint32 @@ -2326,7 +2326,7 @@ gtk_get_current_event_time (void) * that state field in @state and return %TRUE, otherwise return * %FALSE. * - * Return value: %TRUE if there was a current event and it + * Returns: %TRUE if there was a current event and it * had a state field */ gboolean @@ -2368,7 +2368,7 @@ gtk_get_current_event_device (void) * returns %NULL, otherwise returns the widget that received the event * originally. * - * Return value: (transfer none): the widget that originally + * Returns: (transfer none): the widget that originally * received @event, or %NULL */ GtkWidget* diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c index bb0e5d69d3..a31ec09004 100644 --- a/gtk/gtkmenu.c +++ b/gtk/gtkmenu.c @@ -2363,7 +2363,7 @@ gtk_menu_set_tearoff_state (GtkMenu *menu, * Returns whether the menu is torn off. * See gtk_menu_set_tearoff_state(). * - * Return value: %TRUE if the menu is currently torn off. + * Returns: %TRUE if the menu is currently torn off. * * Deprecated: 3.10 */ @@ -2412,7 +2412,7 @@ gtk_menu_set_title (GtkMenu *menu, * * Returns the title of the menu. See gtk_menu_set_title(). * - * Return value: the title of the menu, or %NULL if the menu + * Returns: the title of the menu, or %NULL if the menu * has no title set on it. This string is owned by GTK+ * and should not be modified or freed. * @@ -5517,7 +5517,7 @@ gtk_menu_get_monitor (GtkMenu *menu) * Returns a list of the menus which are attached to this widget. * This list is owned by GTK+ and must not be modified. * - * Return value: (element-type GtkWidget) (transfer none): the list + * Returns: (element-type GtkWidget) (transfer none): the list * of menus attached to his widget. * * Since: 2.6 diff --git a/gtk/gtkmenubar.c b/gtk/gtkmenubar.c index cf84de8379..217308577f 100644 --- a/gtk/gtkmenubar.c +++ b/gtk/gtkmenubar.c @@ -913,7 +913,7 @@ gtk_menu_bar_move_current (GtkMenuShell *menu_shell, * Retrieves the current pack direction of the menubar. * See gtk_menu_bar_set_pack_direction(). * - * Return value: the pack direction + * Returns: the pack direction * * Since: 2.8 */ @@ -966,7 +966,7 @@ gtk_menu_bar_set_pack_direction (GtkMenuBar *menubar, * Retrieves the current child pack direction of the menubar. * See gtk_menu_bar_set_child_pack_direction(). * - * Return value: the child pack direction + * Returns: the child pack direction * * Since: 2.8 */ diff --git a/gtk/gtkmenubutton.c b/gtk/gtkmenubutton.c index 3a81230e57..aa11a8d3e6 100644 --- a/gtk/gtkmenubutton.c +++ b/gtk/gtkmenubutton.c @@ -1055,7 +1055,7 @@ gtk_menu_button_set_use_popover (GtkMenuButton *menu_button, * Returns whether a #GtkPopover or a #GtkMenu will be constructed * from the menu model. * - * Return value: %TRUE if using a #GtkPopover + * Returns: %TRUE if using a #GtkPopover * * Since: 3.12 */ diff --git a/gtk/gtkmenuitem.c b/gtk/gtkmenuitem.c index a4bb5613ac..e36715feb9 100644 --- a/gtk/gtkmenuitem.c +++ b/gtk/gtkmenuitem.c @@ -1137,7 +1137,7 @@ activatable_update_label (GtkMenuItem *menu_item, GtkAction *action) * * This function is used by #GtkAction. * - * Return value: whether @menu is empty. + * Returns: whether @menu is empty. **/ static gboolean gtk_menu_is_empty (GtkWidget *menu) @@ -1358,7 +1358,7 @@ gtk_menu_item_set_submenu (GtkMenuItem *menu_item, * Gets the submenu underneath this menu item, if any. * See gtk_menu_item_set_submenu(). * - * Return value: (transfer none): submenu for this menu item, or %NULL if none + * Returns: (transfer none): submenu for this menu item, or %NULL if none */ GtkWidget * gtk_menu_item_get_submenu (GtkMenuItem *menu_item) @@ -2262,7 +2262,7 @@ gtk_menu_item_set_right_justified (GtkMenuItem *menu_item, * Gets whether the menu item appears justified at the right * side of the menu bar. * - * Return value: %TRUE if the menu item will appear at the + * Returns: %TRUE if the menu item will appear at the * far right if added to a menu bar. * * Deprecated: 3.2: See gtk_menu_item_set_right_justified() @@ -2593,7 +2593,7 @@ gtk_menu_item_set_use_underline (GtkMenuItem *menu_item, * Checks if an underline in the text indicates the next character * should be used for the mnemonic accelerator key. * - * Return value: %TRUE if an embedded underline in the label + * Returns: %TRUE if an embedded underline in the label * indicates the mnemonic accelerator key. * * Since: 2.16 diff --git a/gtk/gtkmenutoolbutton.c b/gtk/gtkmenutoolbutton.c index 3385e13fcb..f2932cc198 100644 --- a/gtk/gtkmenutoolbutton.c +++ b/gtk/gtkmenutoolbutton.c @@ -335,7 +335,7 @@ gtk_menu_tool_button_buildable_interface_init (GtkBuildableIface *iface) * Creates a new #GtkMenuToolButton using @icon_widget as icon and * @label as label. * - * Return value: the new #GtkMenuToolButton + * Returns: the new #GtkMenuToolButton * * Since: 2.6 **/ @@ -364,7 +364,7 @@ gtk_menu_tool_button_new (GtkWidget *icon_widget, * The new #GtkMenuToolButton will contain an icon and label from * the stock item indicated by @stock_id. * - * Return value: the new #GtkMenuToolButton + * Returns: the new #GtkMenuToolButton * * Since: 2.6 * @@ -426,7 +426,7 @@ gtk_menu_tool_button_set_menu (GtkMenuToolButton *button, * * Gets the #GtkMenu associated with #GtkMenuToolButton. * - * Return value: (transfer none): the #GtkMenu associated + * Returns: (transfer none): the #GtkMenu associated * with #GtkMenuToolButton * * Since: 2.6 diff --git a/gtk/gtkmessagedialog.c b/gtk/gtkmessagedialog.c index 1a90e3e211..e3f8ec4ff9 100644 --- a/gtk/gtkmessagedialog.c +++ b/gtk/gtkmessagedialog.c @@ -529,7 +529,7 @@ gtk_message_dialog_get_property (GObject *object, * signal is emitted with response IDs from #GtkResponseType. See * #GtkDialog for more details. * - * Return value: (transfer none): a new #GtkMessageDialog + * Returns: (transfer none): a new #GtkMessageDialog */ GtkWidget* gtk_message_dialog_new (GtkWindow *parent, @@ -614,7 +614,7 @@ gtk_message_dialog_new (GtkWindow *parent, * markup); * ]| * - * Return value: a new #GtkMessageDialog + * Returns: a new #GtkMessageDialog * * Since: 2.4 **/ @@ -696,7 +696,7 @@ gtk_message_dialog_set_image (GtkMessageDialog *dialog, * * Gets the dialog’s image. * - * Return value: (transfer none): the dialog’s image + * Returns: (transfer none): the dialog’s image * * Since: 2.14 * Deprecated: 3.12: Use #GtkDialog for dialogs with images @@ -851,7 +851,7 @@ gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog, * See gtk_dialog_get_content_area() for the corresponding * function in the parent #GtkDialog. * - * Return value: (transfer none): A #GtkVBox corresponding to the + * Returns: (transfer none): A #GtkVBox corresponding to the * “message area” in the @message_dialog. * * Since: 2.22 diff --git a/gtk/gtkmodules.c b/gtk/gtkmodules.c index 6ececa1ebd..640be7bb55 100644 --- a/gtk/gtkmodules.c +++ b/gtk/gtkmodules.c @@ -89,7 +89,7 @@ get_module_path (void) * * Determines the search path for a particular type of module. * - * Return value: the search path for the module type. Free with g_strfreev(). + * Returns: the search path for the module type. Free with g_strfreev(). **/ gchar ** _gtk_get_module_path (const gchar *type) @@ -165,7 +165,7 @@ module_build_la_path (const gchar *directory, * Looks for a dynamically module named @name of type @type in the standard GTK+ * module search path. * - * Return value: the pathname to the found module, or %NULL if it wasn’t found. + * Returns: the pathname to the found module, or %NULL if it wasn’t found. * Free with g_free(). **/ gchar * diff --git a/gtk/gtknotebook.c b/gtk/gtknotebook.c index 2debf9ead5..dff3c3ee57 100644 --- a/gtk/gtknotebook.c +++ b/gtk/gtknotebook.c @@ -1566,7 +1566,7 @@ gtk_notebook_reorder_tab (GtkNotebook *notebook, * * Creates a new #GtkNotebook widget with no pages. - * Return value: the newly created #GtkNotebook + * Returns: the newly created #GtkNotebook */ GtkWidget* gtk_notebook_new (void) @@ -6957,7 +6957,7 @@ gtk_notebook_menu_detacher (GtkWidget *widget, * * Appends a page to @notebook. * - * Return value: the index (starting from 0) of the appended + * Returns: the index (starting from 0) of the appended * page in the notebook, or -1 if function fails */ gint @@ -6988,7 +6988,7 @@ gtk_notebook_append_page (GtkNotebook *notebook, * Appends a page to @notebook, specifying the widget to use as the * label in the popup menu. * - * Return value: the index (starting from 0) of the appended + * Returns: the index (starting from 0) of the appended * page in the notebook, or -1 if function fails */ gint @@ -7014,7 +7014,7 @@ gtk_notebook_append_page_menu (GtkNotebook *notebook, * * Prepends a page to @notebook. * - * Return value: the index (starting from 0) of the prepended + * Returns: the index (starting from 0) of the prepended * page in the notebook, or -1 if function fails */ gint @@ -7045,7 +7045,7 @@ gtk_notebook_prepend_page (GtkNotebook *notebook, * Prepends a page to @notebook, specifying the widget to use as the * label in the popup menu. * - * Return value: the index (starting from 0) of the prepended + * Returns: the index (starting from 0) of the prepended * page in the notebook, or -1 if function fails */ gint @@ -7073,7 +7073,7 @@ gtk_notebook_prepend_page_menu (GtkNotebook *notebook, * * Insert a page into @notebook at the given position. * - * Return value: the index (starting from 0) of the inserted + * Returns: the index (starting from 0) of the inserted * page in the notebook, or -1 if function fails */ gint @@ -7138,7 +7138,7 @@ gtk_notebook_mnemonic_activate_switch_page (GtkWidget *child, * Insert a page into @notebook at the given position, specifying * the widget to use as the label in the popup menu. * - * Return value: the index (starting from 0) of the inserted + * Returns: the index (starting from 0) of the inserted * page in the notebook */ gint @@ -7203,7 +7203,7 @@ gtk_notebook_remove_page (GtkNotebook *notebook, * * Returns the page number of the current page. * - * Return value: the index (starting from 0) of the current + * Returns: the index (starting from 0) of the current * page in the notebook. If the notebook has no pages, * then -1 will be returned. */ @@ -7230,7 +7230,7 @@ gtk_notebook_get_current_page (GtkNotebook *notebook) * * Returns the child widget contained in page number @page_num. * - * Return value: (transfer none): the child widget, or %NULL + * Returns: (transfer none): the child widget, or %NULL * if @page_num is out of bounds */ GtkWidget* @@ -7265,7 +7265,7 @@ gtk_notebook_get_nth_page (GtkNotebook *notebook, * * Gets the number of pages in a notebook. * - * Return value: the number of pages in the notebook + * Returns: the number of pages in the notebook * * Since: 2.2 */ @@ -7289,7 +7289,7 @@ gtk_notebook_get_n_pages (GtkNotebook *notebook) * Finds the index of the page which contains the given child * widget. * - * Return value: the index of the page containing @child, or + * Returns: the index of the page containing @child, or * -1 if @child is not in the notebook */ gint @@ -7460,7 +7460,7 @@ gtk_notebook_set_show_border (GtkNotebook *notebook, * Returns whether a bevel will be drawn around the notebook pages. * See gtk_notebook_set_show_border(). * - * Return value: %TRUE if the bevel is drawn + * Returns: %TRUE if the bevel is drawn */ gboolean gtk_notebook_get_show_border (GtkNotebook *notebook) @@ -7545,7 +7545,7 @@ gtk_notebook_set_show_tabs (GtkNotebook *notebook, * Returns whether the tabs of the notebook are shown. * See gtk_notebook_set_show_tabs(). * - * Return value: %TRUE if the tabs are shown + * Returns: %TRUE if the tabs are shown */ gboolean gtk_notebook_get_show_tabs (GtkNotebook *notebook) @@ -7590,7 +7590,7 @@ gtk_notebook_set_tab_pos (GtkNotebook *notebook, * Gets the edge at which the tabs for switching pages in the * notebook are drawn. * - * Return value: the edge at which the tabs are drawn + * Returns: the edge at which the tabs are drawn */ GtkPositionType gtk_notebook_get_tab_pos (GtkNotebook *notebook) @@ -7638,7 +7638,7 @@ gtk_notebook_set_scrollable (GtkNotebook *notebook, * Returns whether the tab label area has arrows for scrolling. * See gtk_notebook_set_scrollable(). * - * Return value: %TRUE if arrows for scrolling are present + * Returns: %TRUE if arrows for scrolling are present */ gboolean gtk_notebook_get_scrollable (GtkNotebook *notebook) @@ -7654,7 +7654,7 @@ gtk_notebook_get_scrollable (GtkNotebook *notebook) * * Returns the horizontal width of a tab border. * - * Return value: horizontal width of a tab border + * Returns: horizontal width of a tab border * * Since: 2.22 * @@ -7674,7 +7674,7 @@ gtk_notebook_get_tab_hborder (GtkNotebook *notebook) * * Returns the vertical width of a tab border. * - * Return value: vertical width of a tab border + * Returns: vertical width of a tab border * * Since: 2.22 * @@ -7782,7 +7782,7 @@ gtk_notebook_popup_disable (GtkNotebook *notebook) * %NULL is returned if @child is not in @notebook or * if no tab label has specifically been set for @child. * - * Return value: (transfer none): the tab label + * Returns: (transfer none): the tab label */ GtkWidget * gtk_notebook_get_tab_label (GtkNotebook *notebook, @@ -7922,7 +7922,7 @@ gtk_notebook_set_tab_label_text (GtkNotebook *notebook, * Retrieves the text of the tab label for the page containing * @child. * - * Return value: the text of the tab label, or %NULL if the + * Returns: the text of the tab label, or %NULL if the * tab label widget is not a #GtkLabel. The string is owned * by the widget and must not be freed. */ @@ -7950,7 +7950,7 @@ gtk_notebook_get_tab_label_text (GtkNotebook *notebook, * * Retrieves the menu label widget of the page containing @child. * - * Return value: (transfer none): the menu label, or %NULL if the + * Returns: (transfer none): the menu label, or %NULL if the * notebook page does not have a menu label other than the * default (the tab label). */ @@ -8059,7 +8059,7 @@ gtk_notebook_set_menu_label_text (GtkNotebook *notebook, * Retrieves the text of the menu label for the page containing * @child. * - * Return value: the text of the tab label, or %NULL if the + * Returns: the text of the tab label, or %NULL if the * widget does not have a menu label other than the default * menu label, or the menu label widget is not a #GtkLabel. * The string is owned by the widget and must not be freed. @@ -8276,7 +8276,7 @@ gtk_notebook_set_group_name (GtkNotebook *notebook, * * Gets the current group name for @notebook. * - * Return Value: (transfer none): the group name, + * Returns: (transfer none): the group name, * or %NULL if none is set. * * Since: 2.24 @@ -8296,7 +8296,7 @@ gtk_notebook_get_group_name (GtkNotebook *notebook) * * Gets whether the tab can be reordered via drag and drop or not. * - * Return Value: %TRUE if the tab is reorderable. + * Returns: %TRUE if the tab is reorderable. * * Since: 2.10 */ @@ -8357,7 +8357,7 @@ gtk_notebook_set_tab_reorderable (GtkNotebook *notebook, * * Returns whether the tab contents can be detached from @notebook. * - * Return Value: %TRUE if the tab is detachable. + * Returns: %TRUE if the tab is detachable. * * Since: 2.10 */ diff --git a/gtk/gtkoffscreenwindow.c b/gtk/gtkoffscreenwindow.c index 8e9f23f02c..192db55b4e 100644 --- a/gtk/gtkoffscreenwindow.c +++ b/gtk/gtkoffscreenwindow.c @@ -282,7 +282,7 @@ gtk_offscreen_window_init (GtkOffscreenWindow *window) * Creates a toplevel container widget that is used to retrieve * snapshots of widgets without showing them on the screen. * - * Return value: A pointer to a #GtkWidget + * Returns: A pointer to a #GtkWidget * * Since: 2.20 */ diff --git a/gtk/gtkorientable.c b/gtk/gtkorientable.c index 5c313c4fae..6917c4ed2c 100644 --- a/gtk/gtkorientable.c +++ b/gtk/gtkorientable.c @@ -94,7 +94,7 @@ gtk_orientable_set_orientation (GtkOrientable *orientable, * * Retrieves the orientation of the @orientable. * - * Return value: the orientation of the @orientable. + * Returns: the orientation of the @orientable. * * Since: 2.16 **/ diff --git a/gtk/gtkpagesetup.c b/gtk/gtkpagesetup.c index 59bae8d32e..53d0f7b41f 100644 --- a/gtk/gtkpagesetup.c +++ b/gtk/gtkpagesetup.c @@ -133,7 +133,7 @@ gtk_page_setup_class_init (GtkPageSetupClass *class) * * Creates a new #GtkPageSetup. * - * Return value: a new #GtkPageSetup. + * Returns: a new #GtkPageSetup. * * Since: 2.10 */ @@ -149,7 +149,7 @@ gtk_page_setup_new (void) * * Copies a #GtkPageSetup. * - * Return value: (transfer full): a copy of @other + * Returns: (transfer full): a copy of @other * * Since: 2.10 */ @@ -176,7 +176,7 @@ gtk_page_setup_copy (GtkPageSetup *other) * * Gets the page orientation of the #GtkPageSetup. * - * Return value: the page orientation + * Returns: the page orientation * * Since: 2.10 */ @@ -208,7 +208,7 @@ gtk_page_setup_set_orientation (GtkPageSetup *setup, * * Gets the paper size of the #GtkPageSetup. * - * Return value: the paper size + * Returns: the paper size * * Since: 2.10 */ @@ -276,7 +276,7 @@ gtk_page_setup_set_paper_size_and_default_margins (GtkPageSetup *setup, * * Gets the top margin in units of @unit. * - * Return value: the top margin + * Returns: the top margin * * Since: 2.10 */ @@ -312,7 +312,7 @@ gtk_page_setup_set_top_margin (GtkPageSetup *setup, * * Gets the bottom margin in units of @unit. * - * Return value: the bottom margin + * Returns: the bottom margin * * Since: 2.10 */ @@ -348,7 +348,7 @@ gtk_page_setup_set_bottom_margin (GtkPageSetup *setup, * * Gets the left margin in units of @unit. * - * Return value: the left margin + * Returns: the left margin * * Since: 2.10 */ @@ -384,7 +384,7 @@ gtk_page_setup_set_left_margin (GtkPageSetup *setup, * * Gets the right margin in units of @unit. * - * Return value: the right margin + * Returns: the right margin * * Since: 2.10 */ @@ -424,7 +424,7 @@ gtk_page_setup_set_right_margin (GtkPageSetup *setup, * not margins into consideration. * See gtk_page_setup_get_page_width(). * - * Return value: the paper width. + * Returns: the paper width. * * Since: 2.10 */ @@ -450,7 +450,7 @@ gtk_page_setup_get_paper_width (GtkPageSetup *setup, * not margins into consideration. * See gtk_page_setup_get_page_height(). * - * Return value: the paper height. + * Returns: the paper height. * * Since: 2.10 */ @@ -476,7 +476,7 @@ gtk_page_setup_get_paper_height (GtkPageSetup *setup, * margins into consideration. * See gtk_page_setup_get_paper_width(). * - * Return value: the page width. + * Returns: the page width. * * Since: 2.10 */ @@ -503,7 +503,7 @@ gtk_page_setup_get_page_width (GtkPageSetup *setup, * margins into consideration. * See gtk_page_setup_get_paper_height(). * - * Return value: the page height. + * Returns: the page height. * * Since: 2.10 */ @@ -528,7 +528,7 @@ gtk_page_setup_get_page_height (GtkPageSetup *setup, * Reads the page setup from the file @file_name. * See gtk_page_setup_to_file(). * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.14 */ @@ -563,7 +563,7 @@ gtk_page_setup_load_file (GtkPageSetup *setup, * new #GtkPageSetup object with the restored page setup, * or %NULL if an error occurred. See gtk_page_setup_to_file(). * - * Return value: the restored #GtkPageSetup + * Returns: the restored #GtkPageSetup * * Since: 2.12 */ @@ -614,7 +614,7 @@ string_to_enum (GType type, * Reads the page setup from the group @group_name in the key file * @key_file. * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.14 */ @@ -703,7 +703,7 @@ out: * @key_file. Returns a new #GtkPageSetup object with the restored * page setup, or %NULL if an error occurred. * - * Return value: the restored #GtkPageSetup + * Returns: the restored #GtkPageSetup * * Since: 2.12 */ @@ -731,7 +731,7 @@ gtk_page_setup_new_from_key_file (GKeyFile *key_file, * * This function saves the information from @setup to @file_name. * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.12 */ diff --git a/gtk/gtkpaned.c b/gtk/gtkpaned.c index b25d243a77..2fe515a5bd 100644 --- a/gtk/gtkpaned.c +++ b/gtk/gtkpaned.c @@ -1877,7 +1877,7 @@ gtk_paned_motion (GtkWidget *widget, * * Creates a new #GtkPaned widget. * - * Return value: a new #GtkPaned. + * Returns: a new #GtkPaned. * * Since: 3.0 **/ @@ -2070,7 +2070,7 @@ gtk_paned_forall (GtkContainer *container, * * Obtains the position of the divider between the two panes. * - * Return value: position of the divider + * Returns: position of the divider **/ gint gtk_paned_get_position (GtkPaned *paned) @@ -2143,7 +2143,7 @@ gtk_paned_set_position (GtkPaned *paned, * * Obtains the first child of the paned widget. * - * Return value: (transfer none): first child, or %NULL if it is not set. + * Returns: (transfer none): first child, or %NULL if it is not set. * * Since: 2.4 **/ @@ -2161,7 +2161,7 @@ gtk_paned_get_child1 (GtkPaned *paned) * * Obtains the second child of the paned widget. * - * Return value: (transfer none): second child, or %NULL if it is not set. + * Returns: (transfer none): second child, or %NULL if it is not set. * * Since: 2.4 **/ @@ -2832,7 +2832,7 @@ gtk_paned_toggle_handle_focus (GtkPaned *paned) * enables the callback to distinguish between the window * of the paned, a child and the handle. * - * Return value: (transfer none): the paned’s handle window. + * Returns: (transfer none): the paned’s handle window. * * Since: 2.20 **/ diff --git a/gtk/gtkpapersize.c b/gtk/gtkpapersize.c index aced21cd52..95ead97b3c 100644 --- a/gtk/gtkpapersize.c +++ b/gtk/gtkpapersize.c @@ -215,7 +215,7 @@ gtk_paper_size_new_from_info (const PaperInfo *info) * If @name is %NULL, the default paper size is returned, * see gtk_paper_size_get_default(). * - * Return value: a new #GtkPaperSize, use gtk_paper_size_free() + * Returns: a new #GtkPaperSize, use gtk_paper_size_free() * to free it * * Since: 2.10 @@ -285,7 +285,7 @@ gtk_paper_size_new (const gchar *name) * @ppd_display_name, @width and @height are used to * construct a custom #GtkPaperSize object. * - * Return value: a new #GtkPaperSize, use gtk_paper_size_free() + * Returns: a new #GtkPaperSize, use gtk_paper_size_free() * to free it * * Since: 2.10 @@ -358,7 +358,7 @@ gtk_paper_size_new_from_ppd (const gchar *ppd_name, * Creates a new #GtkPaperSize object with the * given parameters. * - * Return value: a new #GtkPaperSize object, use gtk_paper_size_free() + * Returns: a new #GtkPaperSize object, use gtk_paper_size_free() * to free it * * Since: 2.10 @@ -392,7 +392,7 @@ gtk_paper_size_new_custom (const gchar *name, * * Copies an existing #GtkPaperSize. * - * Return value: a copy of @other + * Returns: a copy of @other * * Since: 2.10 */ @@ -443,7 +443,7 @@ gtk_paper_size_free (GtkPaperSize *size) * * Compares two #GtkPaperSize objects. * - * Return value: %TRUE, if @size1 and @size2 + * Returns: %TRUE, if @size1 and @size2 * represent the same paper size * * Since: 2.10 @@ -466,7 +466,7 @@ gtk_paper_size_is_equal (GtkPaperSize *size1, * * Creates a list of known paper sizes. * - * Return value: (element-type GtkPaperSize) (transfer full): a newly allocated list of newly + * Returns: (element-type GtkPaperSize) (transfer full): a newly allocated list of newly * allocated #GtkPaperSize objects * * Since: 2.12 @@ -513,7 +513,7 @@ gtk_paper_size_get_paper_sizes (gboolean include_custom) * * Gets the name of the #GtkPaperSize. * - * Return value: the name of @size + * Returns: the name of @size * * Since: 2.10 */ @@ -532,7 +532,7 @@ gtk_paper_size_get_name (GtkPaperSize *size) * * Gets the human-readable name of the #GtkPaperSize. * - * Return value: the human-readable name of @size + * Returns: the human-readable name of @size * * Since: 2.10 */ @@ -557,7 +557,7 @@ gtk_paper_size_get_display_name (GtkPaperSize *size) * Gets the PPD name of the #GtkPaperSize, which * may be %NULL. * - * Return value: the PPD name of @size + * Returns: the PPD name of @size * * Since: 2.10 */ @@ -579,7 +579,7 @@ gtk_paper_size_get_ppd_name (GtkPaperSize *size) * Gets the paper width of the #GtkPaperSize, in * units of @unit. * - * Return value: the paper width + * Returns: the paper width * * Since: 2.10 */ @@ -598,7 +598,7 @@ gtk_paper_size_get_width (GtkPaperSize *size, * Gets the paper height of the #GtkPaperSize, in * units of @unit. * - * Return value: the paper height + * Returns: the paper height * * Since: 2.10 */ @@ -615,7 +615,7 @@ gtk_paper_size_get_height (GtkPaperSize *size, * * Returns %TRUE if @size is not a standard paper size. * - * Return value: whether @size is a custom paper size. + * Returns: whether @size is a custom paper size. **/ gboolean gtk_paper_size_is_custom (GtkPaperSize *size) @@ -656,7 +656,7 @@ gtk_paper_size_set_size (GtkPaperSize *size, * Returns the name of the default paper size, which * depends on the current locale. * - * Return value: the name of the default paper size. The string + * Returns: the name of the default paper size. The string * is owned by GTK+ and should not be modified. * * Since: 2.10 @@ -725,7 +725,7 @@ gtk_paper_size_get_default (void) * * Gets the default top margin for the #GtkPaperSize. * - * Return value: the default top margin + * Returns: the default top margin * * Since: 2.10 */ @@ -746,7 +746,7 @@ gtk_paper_size_get_default_top_margin (GtkPaperSize *size, * * Gets the default bottom margin for the #GtkPaperSize. * - * Return value: the default bottom margin + * Returns: the default bottom margin * * Since: 2.10 */ @@ -775,7 +775,7 @@ gtk_paper_size_get_default_bottom_margin (GtkPaperSize *size, * * Gets the default left margin for the #GtkPaperSize. * - * Return value: the default left margin + * Returns: the default left margin * * Since: 2.10 */ @@ -796,7 +796,7 @@ gtk_paper_size_get_default_left_margin (GtkPaperSize *size, * * Gets the default right margin for the #GtkPaperSize. * - * Return value: the default right margin + * Returns: the default right margin * * Since: 2.10 */ diff --git a/gtk/gtkplacessidebar.c b/gtk/gtkplacessidebar.c index 19af1df342..42ef84f356 100644 --- a/gtk/gtkplacessidebar.c +++ b/gtk/gtkplacessidebar.c @@ -4203,7 +4203,7 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) * * The drag action to use must be the return value of the signal handler. * - * Return value: The drag action to use, for example, #GDK_ACTION_COPY + * Returns: The drag action to use, for example, #GDK_ACTION_COPY * or #GDK_ACTION_MOVE, or 0 if no action is allowed here (i.e. drops * are not allowed in the specified @dest_file). * @@ -4229,7 +4229,7 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class) * The places sidebar emits this signal when it needs to ask the application * to pop up a menu to ask the user for which drag action to perform. * - * Return value: the final drag action that the sidebar should pass to the drag side + * Returns: the final drag action that the sidebar should pass to the drag side * of the drag-and-drop operation. * * Since: 3.10 @@ -4601,7 +4601,7 @@ gtk_places_sidebar_set_show_desktop (GtkPlacesSidebar *sidebar, * * Returns the value previously set with gtk_places_sidebar_set_show_desktop() * - * Return value: %TRUE if the sidebar will display a builtin shortcut to the desktop folder. + * Returns: %TRUE if the sidebar will display a builtin shortcut to the desktop folder. * * Since: 3.10 */ @@ -4645,7 +4645,7 @@ gtk_places_sidebar_set_show_connect_to_server (GtkPlacesSidebar *sidebar, * * Returns the value previously set with gtk_places_sidebar_set_show_connect_to_server() * - * Return value: %TRUE if the sidebar will display a “Connect to Server” item. + * Returns: %TRUE if the sidebar will display a “Connect to Server” item. * * Since: 3.10 */ @@ -4687,7 +4687,7 @@ gtk_places_sidebar_set_local_only (GtkPlacesSidebar *sidebar, * * Returns the value previously set with gtk_places_sidebar_set_local_only(). * - * Return value: %TRUE if the sidebar will only show local files. + * Returns: %TRUE if the sidebar will only show local files. * * Since: 3.12 */ @@ -4786,7 +4786,7 @@ gtk_places_sidebar_remove_shortcut (GtkPlacesSidebar *sidebar, * * Gets the list of shortcuts. * - * Return value: (element-type GFile) (transfer full): + * Returns: (element-type GFile) (transfer full): * A #GSList of #GFile of the locations that have been added as * application-specific shortcuts with gtk_places_sidebar_add_shortcut(). * To free this list, you can use @@ -4813,7 +4813,7 @@ gtk_places_sidebar_list_shortcuts (GtkPlacesSidebar *sidebar) * and returns one of them. This function is used by #GtkFileChooser to implement * the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark. * - * Return value: (transfer full): The bookmark specified by the index @n, or + * Returns: (transfer full): The bookmark specified by the index @n, or * #NULL if no such index exist. Note that the indices start at 0, even though * the file chooser starts them with the keyboard shortcut “Alt-1”. * diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c index 8482dce7b1..53c6f3eed6 100644 --- a/gtk/gtkplug.c +++ b/gtk/gtkplug.c @@ -344,7 +344,7 @@ gtk_plug_set_is_child (GtkPlug *plug, * be used to embed this window inside another window, for * instance with gtk_socket_add_id(). * - * Return value: the window ID for the plug + * Returns: the window ID for the plug **/ Window gtk_plug_get_id (GtkPlug *plug) @@ -363,7 +363,7 @@ gtk_plug_get_id (GtkPlug *plug) * * Determines whether the plug is embedded in a socket. * - * Return value: %TRUE if the plug is embedded in a socket + * Returns: %TRUE if the plug is embedded in a socket * * Since: 2.14 **/ @@ -381,7 +381,7 @@ gtk_plug_get_embedded (GtkPlug *plug) * * Retrieves the socket the plug is embedded in. * - * Return value: (transfer none): the window of the socket, or %NULL + * Returns: (transfer none): the window of the socket, or %NULL * * Since: 2.14 **/ @@ -623,7 +623,7 @@ gtk_plug_construct_for_display (GtkPlug *plug, * by @socket_id. If @socket_id is 0, the plug is left “unplugged” and * can later be plugged into a #GtkSocket by gtk_socket_add_id(). * - * Return value: the new #GtkPlug widget. + * Returns: the new #GtkPlug widget. **/ GtkWidget* gtk_plug_new (Window socket_id) @@ -638,7 +638,7 @@ gtk_plug_new (Window socket_id) * * Create a new plug widget inside the #GtkSocket identified by socket_id. * - * Return value: the new #GtkPlug widget. + * Returns: the new #GtkPlug widget. * * Since: 2.2 */ diff --git a/gtk/gtkpopover.c b/gtk/gtkpopover.c index 1dc99cfc64..26b68dd24d 100644 --- a/gtk/gtkpopover.c +++ b/gtk/gtkpopover.c @@ -2161,7 +2161,7 @@ gtk_popover_bind_model (GtkPopover *popover, * Actions can also be added using gtk_widget_insert_action_group() * on the menus attach widget or on any of its parent widgets. * - * Return value: the new #GtkPopover + * Returns: the new #GtkPopover * * Since: 3.12 */ diff --git a/gtk/gtkprintbackend.c b/gtk/gtkprintbackend.c index fc2a210022..3de625f304 100644 --- a/gtk/gtkprintbackend.c +++ b/gtk/gtkprintbackend.c @@ -300,7 +300,7 @@ _gtk_print_backend_create (const gchar *backend_name) /** * gtk_print_backend_load_modules: * - * Return value: (element-type GtkPrintBackend) (transfer container): + * Returns: (element-type GtkPrintBackend) (transfer container): */ GList * gtk_print_backend_load_modules (void) @@ -588,7 +588,7 @@ gtk_print_backend_set_list_done (GtkPrintBackend *backend) * * Returns the current list of printers. * - * Return value: (element-type GtkPrinter) (transfer container): + * Returns: (element-type GtkPrinter) (transfer container): * A list of #GtkPrinter objects. The list should be freed * with g_list_free(). */ diff --git a/gtk/gtkprintcontext.c b/gtk/gtkprintcontext.c index fe3d4234d8..4b2759054f 100644 --- a/gtk/gtkprintcontext.c +++ b/gtk/gtkprintcontext.c @@ -353,7 +353,7 @@ _gtk_print_context_set_page_setup (GtkPrintContext *context, * Obtains the cairo context that is associated with the * #GtkPrintContext. * - * Return value: (transfer none): the cairo context of @context + * Returns: (transfer none): the cairo context of @context * * Since: 2.10 */ @@ -372,7 +372,7 @@ gtk_print_context_get_cairo_context (GtkPrintContext *context) * Obtains the #GtkPageSetup that determines the page * dimensions of the #GtkPrintContext. * - * Return value: (transfer none): the page setup of @context + * Returns: (transfer none): the page setup of @context * * Since: 2.10 */ @@ -390,7 +390,7 @@ gtk_print_context_get_page_setup (GtkPrintContext *context) * * Obtains the width of the #GtkPrintContext, in pixels. * - * Return value: the width of @context + * Returns: the width of @context * * Since: 2.10 */ @@ -419,7 +419,7 @@ gtk_print_context_get_width (GtkPrintContext *context) * * Obtains the height of the #GtkPrintContext, in pixels. * - * Return value: the height of @context + * Returns: the height of @context * * Since: 2.10 */ @@ -449,7 +449,7 @@ gtk_print_context_get_height (GtkPrintContext *context) * Obtains the horizontal resolution of the #GtkPrintContext, * in dots per inch. * - * Return value: the horizontal resolution of @context + * Returns: the horizontal resolution of @context * * Since: 2.10 */ @@ -468,7 +468,7 @@ gtk_print_context_get_dpi_x (GtkPrintContext *context) * Obtains the vertical resolution of the #GtkPrintContext, * in dots per inch. * - * Return value: the vertical resolution of @context + * Returns: the vertical resolution of @context * * Since: 2.10 */ @@ -490,7 +490,7 @@ gtk_print_context_get_dpi_y (GtkPrintContext *context) * * Obtains the hardware printer margins of the #GtkPrintContext, in units. * - * Return value: %TRUE if the hard margins were retrieved + * Returns: %TRUE if the hard margins were retrieved * * Since: 2.20 */ @@ -543,7 +543,7 @@ _gtk_print_context_set_hard_margins (GtkPrintContext *context, * Returns a #PangoFontMap that is suitable for use * with the #GtkPrintContext. * - * Return value: (transfer none): the font map of @context + * Returns: (transfer none): the font map of @context * * Since: 2.10 */ @@ -562,7 +562,7 @@ gtk_print_context_get_pango_fontmap (GtkPrintContext *context) * Creates a new #PangoContext that can be used with the * #GtkPrintContext. * - * Return value: (transfer full): a new Pango context for @context + * Returns: (transfer full): a new Pango context for @context * * Since: 2.10 */ @@ -596,7 +596,7 @@ gtk_print_context_create_pango_context (GtkPrintContext *context) * Creates a new #PangoLayout that is suitable for use * with the #GtkPrintContext. * - * Return value: (transfer full): a new Pango layout for @context + * Returns: (transfer full): a new Pango layout for @context * * Since: 2.10 */ diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c index 53bc9538e1..63d327b972 100644 --- a/gtk/gtkprinter.c +++ b/gtk/gtkprinter.c @@ -382,7 +382,7 @@ gtk_printer_get_property (GObject *object, * * Creates a new #GtkPrinter. * - * Return value: a new #GtkPrinter + * Returns: a new #GtkPrinter * * Since: 2.10 **/ @@ -408,7 +408,7 @@ gtk_printer_new (const gchar *name, * * Returns the backend of the printer. * - * Return value: (transfer none): the backend of @printer + * Returns: (transfer none): the backend of @printer * * Since: 2.10 */ @@ -426,7 +426,7 @@ gtk_printer_get_backend (GtkPrinter *printer) * * Returns the name of the printer. * - * Return value: the name of @printer + * Returns: the name of @printer * * Since: 2.10 */ @@ -444,7 +444,7 @@ gtk_printer_get_name (GtkPrinter *printer) * * Gets the description of the printer. * - * Return value: the description of @printer + * Returns: the description of @printer * * Since: 2.10 */ @@ -482,7 +482,7 @@ gtk_printer_set_description (GtkPrinter *printer, * Returns the state message describing the current state * of the printer. * - * Return value: the state message of @printer + * Returns: the state message of @printer * * Since: 2.10 */ @@ -520,7 +520,7 @@ gtk_printer_set_state_message (GtkPrinter *printer, * * Returns a description of the location of the printer. * - * Return value: the location of @printer + * Returns: the location of @printer * * Since: 2.10 */ @@ -558,7 +558,7 @@ gtk_printer_set_location (GtkPrinter *printer, * * Gets the name of the icon to use for the printer. * - * Return value: the icon name for @printer + * Returns: the icon name for @printer * * Since: 2.10 */ @@ -591,7 +591,7 @@ gtk_printer_set_icon_name (GtkPrinter *printer, * * Gets the number of jobs currently queued on the printer. * - * Return value: the number of jobs on @printer + * Returns: the number of jobs on @printer * * Since: 2.10 */ @@ -629,7 +629,7 @@ gtk_printer_set_job_count (GtkPrinter *printer, * * Returns whether the printer details are available. * - * Return value: %TRUE if @printer details are available + * Returns: %TRUE if @printer details are available * * Since: 2.12 */ @@ -655,7 +655,7 @@ gtk_printer_set_has_details (GtkPrinter *printer, * Returns whether the printer is currently active (i.e. * accepts new jobs). * - * Return value: %TRUE if @printer is active + * Returns: %TRUE if @printer is active * * Since: 2.10 */ @@ -684,7 +684,7 @@ gtk_printer_set_is_active (GtkPrinter *printer, * A paused printer still accepts jobs, but it is not * printing them. * - * Return value: %TRUE if @printer is paused + * Returns: %TRUE if @printer is paused * * Since: 2.14 */ @@ -720,7 +720,7 @@ gtk_printer_set_is_paused (GtkPrinter *printer, * * Returns whether the printer is accepting jobs * - * Return value: %TRUE if @printer is accepting jobs + * Returns: %TRUE if @printer is accepting jobs * * Since: 2.14 */ @@ -758,7 +758,7 @@ gtk_printer_set_is_accepting_jobs (GtkPrinter *printer, * represent actual printer hardware, but something like * a CUPS class). * - * Return value: %TRUE if @printer is virtual + * Returns: %TRUE if @printer is virtual * * Since: 2.10 */ @@ -777,7 +777,7 @@ gtk_printer_is_virtual (GtkPrinter *printer) * Returns whether the printer accepts input in * PDF format. * - * Return value: %TRUE if @printer accepts PDF + * Returns: %TRUE if @printer accepts PDF * * Since: 2.10 */ @@ -805,7 +805,7 @@ gtk_printer_set_accepts_pdf (GtkPrinter *printer, * Returns whether the printer accepts input in * PostScript format. * - * Return value: %TRUE if @printer accepts PostScript + * Returns: %TRUE if @printer accepts PostScript * * Since: 2.10 */ @@ -850,7 +850,7 @@ gtk_printer_set_is_new (GtkPrinter *printer, * * Returns whether the printer is the default printer. * - * Return value: %TRUE if @printer is the default + * Returns: %TRUE if @printer is the default * * Since: 2.10 */ @@ -949,7 +949,7 @@ _gtk_printer_create_cairo_surface (GtkPrinter *printer, * This will return and empty list unless the printer’s details are * available, see gtk_printer_has_details() and gtk_printer_request_details(). * - * Return value: (element-type GtkPageSetup) (transfer full): a newly allocated list of newly allocated #GtkPageSetup s. + * Returns: (element-type GtkPageSetup) (transfer full): a newly allocated list of newly allocated #GtkPageSetup s. * * Since: 2.12 */ @@ -970,7 +970,7 @@ gtk_printer_list_papers (GtkPrinter *printer) * * Returns default page size of @printer. * - * Return value: a newly allocated #GtkPageSetup with default page size of the printer. + * Returns: a newly allocated #GtkPageSetup with default page size of the printer. * * Since: 2.14 */ @@ -999,7 +999,7 @@ gtk_printer_get_default_page_size (GtkPrinter *printer) * Note: This will not succeed unless the printer’s details are available, * see gtk_printer_has_details() and gtk_printer_request_details(). * - * Return value: %TRUE iff the hard margins were retrieved + * Returns: %TRUE iff the hard margins were retrieved * * Since: 2.20 */ @@ -1028,7 +1028,7 @@ gtk_printer_get_hard_margins (GtkPrinter *printer, * This will return 0 unless the printer’s details are available, see * gtk_printer_has_details() and gtk_printer_request_details(). * - * Return value: the printer’s capabilities + * Returns: the printer’s capabilities * * Since: 2.12 */ @@ -1050,7 +1050,7 @@ gtk_printer_get_capabilities (GtkPrinter *printer) * * Compares two printers. * - * Return value: 0 if the printer match, a negative value if @a < @b, + * Returns: 0 if the printer match, a negative value if @a < @b, * or a positive value if @a > @b * * Since: 2.10 diff --git a/gtk/gtkprinteroptionset.c b/gtk/gtkprinteroptionset.c index 4041462c22..d28b0fb680 100644 --- a/gtk/gtkprinteroptionset.c +++ b/gtk/gtkprinteroptionset.c @@ -144,7 +144,7 @@ gtk_printer_option_set_clear_conflicts (GtkPrinterOptionSet *set) /** * gtk_printer_option_set_get_groups: * - * Return value: (element-type utf8) (transfer full): + * Returns: (element-type utf8) (transfer full): */ GList * gtk_printer_option_set_get_groups (GtkPrinterOptionSet *set) diff --git a/gtk/gtkprintjob.c b/gtk/gtkprintjob.c index ba44d4039a..d31b7dc061 100644 --- a/gtk/gtkprintjob.c +++ b/gtk/gtkprintjob.c @@ -303,7 +303,7 @@ gtk_print_job_finalize (GObject *object) * * Creates a new #GtkPrintJob. * - * Return value: a new #GtkPrintJob + * Returns: a new #GtkPrintJob * * Since: 2.10 **/ @@ -329,7 +329,7 @@ gtk_print_job_new (const gchar *title, * * Gets the #GtkPrintSettings of the print job. * - * Return value: (transfer none): the settings of @job + * Returns: (transfer none): the settings of @job * * Since: 2.10 */ @@ -347,7 +347,7 @@ gtk_print_job_get_settings (GtkPrintJob *job) * * Gets the #GtkPrinter of the print job. * - * Return value: (transfer none): the printer of @job + * Returns: (transfer none): the printer of @job * * Since: 2.10 */ @@ -365,7 +365,7 @@ gtk_print_job_get_printer (GtkPrintJob *job) * * Gets the job title. * - * Return value: the title of @job + * Returns: the title of @job * * Since: 2.10 */ @@ -383,7 +383,7 @@ gtk_print_job_get_title (GtkPrintJob *job) * * Gets the status of the print job. * - * Return value: the status of @job + * Returns: the status of @job * * Since: 2.10 */ @@ -464,7 +464,7 @@ gtk_print_job_set_source_file (GtkPrintJob *job, * Gets a cairo surface onto which the pages of * the print job should be rendered. * - * Return value: (transfer none): the cairo surface of @job + * Returns: (transfer none): the cairo surface of @job * * Since: 2.10 **/ @@ -575,7 +575,7 @@ gtk_print_job_set_track_print_status (GtkPrintJob *job, * Returns wheter jobs will be tracked after printing. * For details, see gtk_print_job_set_track_print_status(). * - * Return value: %TRUE if print job status will be reported after printing + * Returns: %TRUE if print job status will be reported after printing * * Since: 2.10 */ diff --git a/gtk/gtkprintoperation-unix.c b/gtk/gtkprintoperation-unix.c index 6b24217987..ebf2a4d30f 100644 --- a/gtk/gtkprintoperation-unix.c +++ b/gtk/gtkprintoperation-unix.c @@ -965,7 +965,7 @@ get_page_setup_dialog (GtkWindow *parent, * setup dialog. See gtk_print_run_page_setup_dialog_async() if this is * a problem. * - * Return value: (transfer full): a new #GtkPageSetup + * Returns: (transfer full): a new #GtkPageSetup * * Since: 2.10 */ diff --git a/gtk/gtkprintoperation.c b/gtk/gtkprintoperation.c index 02b036416c..245908087d 100644 --- a/gtk/gtkprintoperation.c +++ b/gtk/gtkprintoperation.c @@ -166,7 +166,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkPrintOperation, gtk_print_operation, G_TYPE_OBJECT, * * Registers an error quark for #GtkPrintOperation if necessary. * - * Return value: The error quark used for #GtkPrintOperation errors. + * Returns: The error quark used for #GtkPrintOperation errors. * * Since: 2.10 **/ @@ -804,7 +804,7 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class) * it all in the ::begin-print handler, and set the number of pages * from there. * - * Return value: %TRUE if pagination is complete + * Returns: %TRUE if pagination is complete * * Since: 2.10 */ @@ -1550,7 +1550,7 @@ gtk_print_operation_set_print_settings (GtkPrintOperation *op, * gtk_print_operation_set_print_settings() or * gtk_print_operation_run() have been called. * - * Return value: (transfer none): the current print settings of @op. + * Returns: (transfer none): the current print settings of @op. * * Since: 2.10 **/ @@ -1809,7 +1809,7 @@ _gtk_print_operation_set_status (GtkPrintOperation *op, * Returns the status of the print operation. * Also see gtk_print_operation_get_status_string(). * - * Return value: the status of the print operation + * Returns: the status of the print operation * * Since: 2.10 **/ @@ -1833,7 +1833,7 @@ gtk_print_operation_get_status (GtkPrintOperation *op) * Use gtk_print_operation_get_status() to obtain a status * value that is suitable for programmatic use. * - * Return value: a string representation of the status + * Returns: a string representation of the status * of the print operation * * Since: 2.10 @@ -1858,7 +1858,7 @@ gtk_print_operation_get_status_string (GtkPrintOperation *op) * can be in a non-finished state even after done has been called, as * the operation status then tracks the print job status on the printer. * - * Return value: %TRUE, if the print operation is finished. + * Returns: %TRUE, if the print operation is finished. * * Since: 2.10 **/ @@ -3157,7 +3157,7 @@ gtk_print_operation_get_error (GtkPrintOperation *op, * Note that gtk_print_operation_run() can only be called once on a * given #GtkPrintOperation. * - * Return value: the result of the print operation. A return value of + * Returns: the result of the print operation. A return value of * %GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was * completed successfully. In this case, it is a good idea to obtain * the used print settings with gtk_print_operation_get_print_settings() diff --git a/gtk/gtkprintsettings.c b/gtk/gtkprintsettings.c index 39d3a83352..160af5b3fc 100644 --- a/gtk/gtkprintsettings.c +++ b/gtk/gtkprintsettings.c @@ -103,7 +103,7 @@ gtk_print_settings_class_init (GtkPrintSettingsClass *class) * * Creates a new #GtkPrintSettings object. * - * Return value: a new #GtkPrintSettings object + * Returns: a new #GtkPrintSettings object * * Since: 2.10 */ @@ -133,7 +133,7 @@ copy_hash_entry (gpointer key, * * Copies a #GtkPrintSettings object. * - * Return value: (transfer full): a newly allocated copy of @other + * Returns: (transfer full): a newly allocated copy of @other * * Since: 2.10 */ @@ -163,7 +163,7 @@ gtk_print_settings_copy (GtkPrintSettings *other) * * Looks up the string value associated with @key. * - * Return value: the string value for @key + * Returns: the string value for @key * * Since: 2.10 */ @@ -221,7 +221,7 @@ gtk_print_settings_unset (GtkPrintSettings *settings, * * Returns %TRUE, if a value is associated with @key. * - * Return value: %TRUE, if @key has a value + * Returns: %TRUE, if @key has a value * * Since: 2.10 */ @@ -244,7 +244,7 @@ gtk_print_settings_has_key (GtkPrintSettings *settings, * The string “true” represents %TRUE, any other * string %FALSE. * - * Return value: %TRUE, if @key maps to a true value. + * Returns: %TRUE, if @key maps to a true value. * * Since: 2.10 **/ @@ -274,7 +274,7 @@ gtk_print_settings_get_bool (GtkPrintSettings *settings, * The string “true” represents %TRUE, the string * “false” represents %FALSE. * - * Return value: the boolean value associated with @key + * Returns: the boolean value associated with @key * * Since: 2.10 */ @@ -328,7 +328,7 @@ gtk_print_settings_set_bool (GtkPrintSettings *settings, * * Floating point numbers are parsed with g_ascii_strtod(). * - * Return value: the floating point number associated with @key + * Returns: the floating point number associated with @key * * Since: 2.10 */ @@ -353,7 +353,7 @@ gtk_print_settings_get_double_with_default (GtkPrintSettings *settings, * * Returns the double value associated with @key, or 0. * - * Return value: the double value of @key + * Returns: the double value of @key * * Since: 2.10 */ @@ -394,7 +394,7 @@ gtk_print_settings_set_double (GtkPrintSettings *settings, * Returns the value associated with @key, interpreted * as a length. The returned value is converted to @units. * - * Return value: the length value of @key, converted to @unit + * Returns: the length value of @key, converted to @unit * * Since: 2.10 */ @@ -437,7 +437,7 @@ gtk_print_settings_set_length (GtkPrintSettings *settings, * Returns the value of @key, interpreted as * an integer, or the default value. * - * Return value: the integer value of @key + * Returns: the integer value of @key * * Since: 2.10 */ @@ -462,7 +462,7 @@ gtk_print_settings_get_int_with_default (GtkPrintSettings *settings, * * Returns the integer value of @key, or 0. * - * Return value: the integer value of @key + * Returns: the integer value of @key * * Since: 2.10 */ @@ -518,7 +518,7 @@ gtk_print_settings_foreach (GtkPrintSettings *settings, * Convenience function to obtain the value of * %GTK_PRINT_SETTINGS_PRINTER. * - * Return value: the printer name + * Returns: the printer name * * Since: 2.10 */ @@ -553,7 +553,7 @@ gtk_print_settings_set_printer (GtkPrintSettings *settings, * Get the value of %GTK_PRINT_SETTINGS_ORIENTATION, * converted to a #GtkPageOrientation. * - * Return value: the orientation + * Returns: the orientation * * Since: 2.10 */ @@ -620,7 +620,7 @@ gtk_print_settings_set_orientation (GtkPrintSettings *settings, * Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT, * converted to a #GtkPaperSize. * - * Return value: the paper size + * Returns: the paper size * * Since: 2.10 */ @@ -697,7 +697,7 @@ gtk_print_settings_set_paper_size (GtkPrintSettings *settings, * Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH, * converted to @unit. * - * Return value: the paper width, in units of @unit + * Returns: the paper width, in units of @unit * * Since: 2.10 */ @@ -734,7 +734,7 @@ gtk_print_settings_set_paper_width (GtkPrintSettings *settings, * Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT, * converted to @unit. * - * Return value: the paper height, in units of @unit + * Returns: the paper height, in units of @unit * * Since: 2.10 */ @@ -773,7 +773,7 @@ gtk_print_settings_set_paper_height (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR. * - * Return value: whether to use color + * Returns: whether to use color * * Since: 2.10 */ @@ -809,7 +809,7 @@ gtk_print_settings_set_use_color (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_COLLATE. * - * Return value: whether to collate the printed pages + * Returns: whether to collate the printed pages * * Since: 2.10 */ @@ -845,7 +845,7 @@ gtk_print_settings_set_collate (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_REVERSE. * - * Return value: whether to reverse the order of the printed pages + * Returns: whether to reverse the order of the printed pages * * Since: 2.10 */ @@ -880,7 +880,7 @@ gtk_print_settings_set_reverse (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_DUPLEX. * - * Return value: whether to print the output in duplex. + * Returns: whether to print the output in duplex. * * Since: 2.10 */ @@ -941,7 +941,7 @@ gtk_print_settings_set_duplex (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_QUALITY. * - * Return value: the print quality + * Returns: the print quality * * Since: 2.10 */ @@ -1008,7 +1008,7 @@ gtk_print_settings_set_quality (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET. * - * Return value: the set of pages to print + * Returns: the set of pages to print * * Since: 2.10 */ @@ -1069,7 +1069,7 @@ gtk_print_settings_set_page_set (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT. * - * Return value: layout of page in number-up mode + * Returns: layout of page in number-up mode * * Since: 2.14 */ @@ -1136,7 +1136,7 @@ gtk_print_settings_set_number_up_layout (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_N_COPIES. * - * Return value: the number of copies to print + * Returns: the number of copies to print * * Since: 2.10 */ @@ -1169,7 +1169,7 @@ gtk_print_settings_set_n_copies (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP. * - * Return value: the number of pages per sheet + * Returns: the number of pages per sheet * * Since: 2.10 */ @@ -1202,7 +1202,7 @@ gtk_print_settings_set_number_up (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION. * - * Return value: the resolution in dpi + * Returns: the resolution in dpi * * Since: 2.10 */ @@ -1241,7 +1241,7 @@ gtk_print_settings_set_resolution (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X. * - * Return value: the horizontal resolution in dpi + * Returns: the horizontal resolution in dpi * * Since: 2.16 */ @@ -1257,7 +1257,7 @@ gtk_print_settings_get_resolution_x (GtkPrintSettings *settings) * * Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y. * - * Return value: the vertical resolution in dpi + * Returns: the vertical resolution in dpi * * Since: 2.16 */ @@ -1298,7 +1298,7 @@ gtk_print_settings_set_resolution_xy (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI. * - * Return value: the resolution in lpi (lines per inch) + * Returns: the resolution in lpi (lines per inch) * * Since: 2.16 */ @@ -1331,7 +1331,7 @@ gtk_print_settings_set_printer_lpi (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_SCALE. * - * Return value: the scale in percent + * Returns: the scale in percent * * Since: 2.10 */ @@ -1366,7 +1366,7 @@ gtk_print_settings_set_scale (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES. * - * Return value: which pages to print + * Returns: which pages to print * * Since: 2.10 */ @@ -1434,7 +1434,7 @@ gtk_print_settings_set_print_pages (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES. * - * Return value: (array length=num_ranges) (transfer full): an array + * Returns: (array length=num_ranges) (transfer full): an array * of #GtkPageRanges. Use g_free() to free the array when * it is no longer needed. * @@ -1535,7 +1535,7 @@ gtk_print_settings_set_page_ranges (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE. * - * Return value: the default source + * Returns: the default source * * Since: 2.10 */ @@ -1570,7 +1570,7 @@ gtk_print_settings_set_default_source (GtkPrintSettings *settings, * The set of media types is defined in PWG 5101.1-2002 PWG. * <!-- FIXME link here --> * - * Return value: the media type + * Returns: the media type * * Since: 2.10 */ @@ -1605,7 +1605,7 @@ gtk_print_settings_set_media_type (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_DITHER. * - * Return value: the dithering that is used + * Returns: the dithering that is used * * Since: 2.10 */ @@ -1637,7 +1637,7 @@ gtk_print_settings_set_dither (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS. * - * Return value: the finishings + * Returns: the finishings * * Since: 2.10 */ @@ -1669,7 +1669,7 @@ gtk_print_settings_set_finishings (GtkPrintSettings *settings, * * Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN. * - * Return value: the output bin + * Returns: the output bin * * Since: 2.10 */ @@ -1705,7 +1705,7 @@ gtk_print_settings_set_output_bin (GtkPrintSettings *settings, * then error is set to either a #GFileError or #GKeyFileError. * See gtk_print_settings_to_file(). * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.14 */ @@ -1741,7 +1741,7 @@ gtk_print_settings_load_file (GtkPrintSettings *settings, * file could not be loaded then error is set to either a #GFileError or * #GKeyFileError. See gtk_print_settings_to_file(). * - * Return value: the restored #GtkPrintSettings + * Returns: the restored #GtkPrintSettings * * Since: 2.12 */ @@ -1772,7 +1772,7 @@ gtk_print_settings_new_from_file (const gchar *file_name, * file could not be loaded then error is set to either a #GFileError or * #GKeyFileError. * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.14 */ @@ -1834,7 +1834,7 @@ gtk_print_settings_load_key_file (GtkPrintSettings *settings, * error occurred. If the file could not be loaded then error is set to either * a #GFileError or #GKeyFileError. * - * Return value: the restored #GtkPrintSettings + * Returns: the restored #GtkPrintSettings * * Since: 2.12 */ @@ -1865,7 +1865,7 @@ gtk_print_settings_new_from_key_file (GKeyFile *key_file, * file could not be loaded then error is set to either a #GFileError or * #GKeyFileError. * - * Return value: %TRUE on success + * Returns: %TRUE on success * * Since: 2.12 */ diff --git a/gtk/gtkprintunixdialog.c b/gtk/gtkprintunixdialog.c index f846a18a06..12cf742c55 100644 --- a/gtk/gtkprintunixdialog.c +++ b/gtk/gtkprintunixdialog.c @@ -3372,7 +3372,7 @@ page_name_func (GtkCellLayout *cell_layout, * * Creates a new #GtkPrintUnixDialog. * - * Return value: a new #GtkPrintUnixDialog + * Returns: a new #GtkPrintUnixDialog * * Since: 2.10 */ diff --git a/gtk/gtkprivate.c b/gtk/gtkprivate.c index 77463e384c..8f0da6d3b3 100644 --- a/gtk/gtkprivate.c +++ b/gtk/gtkprivate.c @@ -89,7 +89,7 @@ _gtk_get_data_prefix (void) * variables, and does return a Unix-style locale string based on * either said environment variables or the thread’s current locale. * - * Return value: a dynamically allocated string, free with g_free(). + * Returns: a dynamically allocated string, free with g_free(). */ gchar * diff --git a/gtk/gtkprogressbar.c b/gtk/gtkprogressbar.c index 71c583391a..568536c1c2 100644 --- a/gtk/gtkprogressbar.c +++ b/gtk/gtkprogressbar.c @@ -1273,7 +1273,7 @@ gtk_progress_bar_set_inverted (GtkProgressBar *pbar, * to the text, not a copy of it, so will become invalid * if you change the text in the progress bar. * - * Return value: text, or %NULL; this string is owned by the widget + * Returns: text, or %NULL; this string is owned by the widget * and should not be modified or freed. */ const gchar* @@ -1290,7 +1290,7 @@ gtk_progress_bar_get_text (GtkProgressBar *pbar) * * Returns the current fraction of the task that’s been completed. * - * Return value: a fraction from 0.0 to 1.0 + * Returns: a fraction from 0.0 to 1.0 */ gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar) @@ -1306,7 +1306,7 @@ gtk_progress_bar_get_fraction (GtkProgressBar *pbar) * * Retrieves the pulse step set with gtk_progress_bar_set_pulse_step(). * - * Return value: a fraction from 0.0 to 1.0 + * Returns: a fraction from 0.0 to 1.0 */ gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar) @@ -1322,7 +1322,7 @@ gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar) * * Gets the value set by gtk_progress_bar_set_inverted(). * - * Return value: %TRUE if the progress bar is inverted + * Returns: %TRUE if the progress bar is inverted */ gboolean gtk_progress_bar_get_inverted (GtkProgressBar *pbar) @@ -1370,7 +1370,7 @@ gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar, * Returns the ellipsizing position of the progress bar. * See gtk_progress_bar_set_ellipsize(). * - * Return value: #PangoEllipsizeMode + * Returns: #PangoEllipsizeMode * * Since: 2.6 */ diff --git a/gtk/gtkradiobutton.c b/gtk/gtkradiobutton.c index 8fcd760197..1e88ac3c04 100644 --- a/gtk/gtkradiobutton.c +++ b/gtk/gtkradiobutton.c @@ -544,7 +544,7 @@ gtk_radio_button_new_with_mnemonic_from_widget (GtkRadioButton *radio_group_memb * * Retrieves the group assigned to a radio button. * - * Return value: (element-type GtkRadioButton) (transfer none): a linked list + * Returns: (element-type GtkRadioButton) (transfer none): a linked list * containing all the radio buttons in the same group * as @radio_button. The returned list is owned by the radio button * and must not be modified or freed. diff --git a/gtk/gtkradiomenuitem.c b/gtk/gtkradiomenuitem.c index 04c192aa84..82bc00108f 100644 --- a/gtk/gtkradiomenuitem.c +++ b/gtk/gtkradiomenuitem.c @@ -284,7 +284,7 @@ gtk_radio_menu_item_new_with_mnemonic (GSList *group, * * Creates a new #GtkRadioMenuItem adding it to the same group as @group. * - * Return value: (transfer none): The new #GtkRadioMenuItem + * Returns: (transfer none): The new #GtkRadioMenuItem * * Since: 2.4 **/ @@ -313,7 +313,7 @@ gtk_radio_menu_item_new_from_widget (GtkRadioMenuItem *group) * * The new #GtkRadioMenuItem is added to the same group as @group. * - * Return value: (transfer none): The new #GtkRadioMenuItem + * Returns: (transfer none): The new #GtkRadioMenuItem * * Since: 2.4 **/ @@ -339,7 +339,7 @@ gtk_radio_menu_item_new_with_mnemonic_from_widget (GtkRadioMenuItem *group, * Creates a new GtkRadioMenuItem whose child is a simple GtkLabel. * The new #GtkRadioMenuItem is added to the same group as @group. * - * Return value: (transfer none): The new #GtkRadioMenuItem + * Returns: (transfer none): The new #GtkRadioMenuItem * * Since: 2.4 **/ diff --git a/gtk/gtkradiotoolbutton.c b/gtk/gtkradiotoolbutton.c index 60d0d4a171..860abd94d3 100644 --- a/gtk/gtkradiotoolbutton.c +++ b/gtk/gtkradiotoolbutton.c @@ -129,7 +129,7 @@ gtk_radio_tool_button_set_property (GObject *object, * * Creates a new #GtkRadioToolButton, adding it to @group. * - * Return value: The new #GtkRadioToolButton + * Returns: The new #GtkRadioToolButton * * Since: 2.4 **/ @@ -156,7 +156,7 @@ gtk_radio_tool_button_new (GSList *group) * The new #GtkRadioToolButton will contain an icon and label from the * stock item indicated by @stock_id. * - * Return value: The new #GtkRadioToolButton + * Returns: The new #GtkRadioToolButton * * Since: 2.4 * @@ -186,7 +186,7 @@ gtk_radio_tool_button_new_from_stock (GSList *group, * * Creates a new #GtkRadioToolButton adding it to the same group as @gruup * - * Return value: (transfer none): The new #GtkRadioToolButton + * Returns: (transfer none): The new #GtkRadioToolButton * * Since: 2.4 **/ @@ -212,7 +212,7 @@ gtk_radio_tool_button_new_from_widget (GtkRadioToolButton *group) * The new #GtkRadioToolButton will contain an icon and label from the * stock item indicated by @stock_id. * - * Return value: (transfer none): A new #GtkRadioToolButton + * Returns: (transfer none): A new #GtkRadioToolButton * * Since: 2.4 * @@ -249,7 +249,7 @@ get_radio_button (GtkRadioToolButton *button) * * Returns the radio button group @button belongs to. * - * Return value: (transfer none) (element-type GtkRadioButton): The group @button belongs to. + * Returns: (transfer none) (element-type GtkRadioButton): The group @button belongs to. * * Since: 2.4 */ diff --git a/gtk/gtkrange.c b/gtk/gtkrange.c index fc16d4b98d..6df5c8a90f 100644 --- a/gtk/gtkrange.c +++ b/gtk/gtkrange.c @@ -763,7 +763,7 @@ gtk_range_init (GtkRange *range) * The return value does not have a reference added, so should not * be unreferenced. * - * Return value: (transfer none): a #GtkAdjustment + * Returns: (transfer none): a #GtkAdjustment **/ GtkAdjustment* gtk_range_get_adjustment (GtkRange *range) @@ -872,7 +872,7 @@ gtk_range_set_inverted (GtkRange *range, * * Gets the value set by gtk_range_set_inverted(). * - * Return value: %TRUE if the range is inverted + * Returns: %TRUE if the range is inverted **/ gboolean gtk_range_get_inverted (GtkRange *range) @@ -920,7 +920,7 @@ gtk_range_set_flippable (GtkRange *range, * * Gets the value set by gtk_range_set_flippable(). * - * Return value: %TRUE if the range is flippable + * Returns: %TRUE if the range is flippable * * Since: 2.18 **/ @@ -975,7 +975,7 @@ gtk_range_set_slider_size_fixed (GtkRange *range, * * See gtk_range_set_slider_size_fixed(). * - * Return value: whether the range’s slider has a fixed size. + * Returns: whether the range’s slider has a fixed size. * * Since: 2.20 **/ @@ -1030,7 +1030,7 @@ gtk_range_set_min_slider_size (GtkRange *range, * * See gtk_range_set_min_slider_size(). * - * Return value: The minimum size of the range’s slider. + * Returns: The minimum size of the range’s slider. * * Since: 2.20 **/ @@ -1144,7 +1144,7 @@ gtk_range_set_lower_stepper_sensitivity (GtkRange *range, * Gets the sensitivity policy for the stepper that points to the * 'lower' end of the GtkRange’s adjustment. * - * Return value: The lower stepper’s sensitivity policy. + * Returns: The lower stepper’s sensitivity policy. * * Since: 2.10 **/ @@ -1195,7 +1195,7 @@ gtk_range_set_upper_stepper_sensitivity (GtkRange *range, * Gets the sensitivity policy for the stepper that points to the * 'upper' end of the GtkRange’s adjustment. * - * Return value: The upper stepper’s sensitivity policy. + * Returns: The upper stepper’s sensitivity policy. * * Since: 2.10 **/ @@ -1310,7 +1310,7 @@ gtk_range_set_value (GtkRange *range, * * Gets the current value of the range. * - * Return value: current value of the range. + * Returns: current value of the range. **/ gdouble gtk_range_get_value (GtkRange *range) @@ -1357,7 +1357,7 @@ gtk_range_set_show_fill_level (GtkRange *range, * * Gets whether the range displays the fill level graphically. * - * Return value: %TRUE if @range shows the fill level. + * Returns: %TRUE if @range shows the fill level. * * Since: 2.12 **/ @@ -1407,7 +1407,7 @@ gtk_range_set_restrict_to_fill_level (GtkRange *range, * * Gets whether the range is restricted to the fill level. * - * Return value: %TRUE if @range is restricted to the fill level. + * Returns: %TRUE if @range is restricted to the fill level. * * Since: 2.12 **/ @@ -1473,7 +1473,7 @@ gtk_range_set_fill_level (GtkRange *range, * * Gets the current position of the fill level indicator. * - * Return value: The current fill level + * Returns: The current fill level * * Since: 2.12 **/ @@ -2961,7 +2961,7 @@ gtk_range_button_release (GtkWidget *widget, * * Returns a good step value for the mouse wheel. * - * Return value: A good step value for the mouse wheel. + * Returns: A good step value for the mouse wheel. * * Since: 2.4 **/ @@ -4376,7 +4376,7 @@ gtk_range_set_round_digits (GtkRange *range, * Gets the number of digits to round the value to when * it changes. See #GtkRange::change-value. * - * Return value: the number of digits to round to + * Returns: the number of digits to round to * * Since: 2.24 */ diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c index b3ee7883b5..8d6e6b4065 100644 --- a/gtk/gtkrecentchooser.c +++ b/gtk/gtkrecentchooser.c @@ -274,7 +274,7 @@ gtk_recent_chooser_error_quark (void) * * Gets the #GtkRecentManager used by @chooser. * - * Return value: the recent manager for @chooser. + * Returns: the recent manager for @chooser. * * Since: 2.10 */ @@ -311,7 +311,7 @@ gtk_recent_chooser_set_show_private (GtkRecentChooser *chooser, * Returns whether @chooser should display recently used resources * registered as private. * - * Return value: %TRUE if the recent chooser should show private items, + * Returns: %TRUE if the recent chooser should show private items, * %FALSE otherwise. * * Since: 2.10 @@ -354,7 +354,7 @@ gtk_recent_chooser_set_show_not_found (GtkRecentChooser *chooser, * Retrieves whether @chooser should show the recently used resources that * were not found. * - * Return value: %TRUE if the resources not found should be displayed, and + * Returns: %TRUE if the resources not found should be displayed, and * %FALSE otheriwse. * * Since: 2.10 @@ -396,7 +396,7 @@ gtk_recent_chooser_set_show_icons (GtkRecentChooser *chooser, * * Retrieves whether @chooser should show an icon near the resource. * - * Return value: %TRUE if the icons should be displayed, %FALSE otherwise. + * Returns: %TRUE if the icons should be displayed, %FALSE otherwise. * * Since: 2.10 */ @@ -436,7 +436,7 @@ gtk_recent_chooser_set_select_multiple (GtkRecentChooser *chooser, * * Gets whether @chooser can select multiple items. * - * Return value: %TRUE if @chooser can select more than one item. + * Returns: %TRUE if @chooser can select more than one item. * * Since: 2.10 */ @@ -480,7 +480,7 @@ gtk_recent_chooser_set_local_only (GtkRecentChooser *chooser, * Gets whether only local resources should be shown in the recently used * resources selector. See gtk_recent_chooser_set_local_only() * - * Return value: %TRUE if only local resources should be shown. + * Returns: %TRUE if only local resources should be shown. * * Since: 2.10 */ @@ -522,7 +522,7 @@ gtk_recent_chooser_set_limit (GtkRecentChooser *chooser, * Gets the number of items returned by gtk_recent_chooser_get_items() * and gtk_recent_chooser_get_uris(). * - * Return value: A positive integer, or -1 meaning that all items are + * Returns: A positive integer, or -1 meaning that all items are * returned. * * Since: 2.10 @@ -565,7 +565,7 @@ gtk_recent_chooser_set_show_tips (GtkRecentChooser *chooser, * Gets whether @chooser should display tooltips containing the full path * of a recently user resource. * - * Return value: %TRUE if the recent chooser should show tooltips, + * Returns: %TRUE if the recent chooser should show tooltips, * %FALSE otherwise. * * Since: 2.10 @@ -626,7 +626,7 @@ gtk_recent_chooser_set_sort_type (GtkRecentChooser *chooser, * * Gets the value set by gtk_recent_chooser_set_sort_type(). * - * Return value: the sorting order of the @chooser. + * Returns: the sorting order of the @chooser. * * Since: 2.10 */ @@ -682,7 +682,7 @@ gtk_recent_chooser_set_sort_func (GtkRecentChooser *chooser, * * Sets @uri as the current URI for @chooser. * - * Return value: %TRUE if the URI was found. + * Returns: %TRUE if the URI was found. * * Since: 2.10 */ @@ -702,7 +702,7 @@ gtk_recent_chooser_set_current_uri (GtkRecentChooser *chooser, * * Gets the URI currently selected by @chooser. * - * Return value: a newly allocated string holding a URI. + * Returns: a newly allocated string holding a URI. * * Since: 2.10 */ @@ -720,7 +720,7 @@ gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser) * * Gets the #GtkRecentInfo currently selected by @chooser. * - * Return value: a #GtkRecentInfo. Use gtk_recent_info_unref() when + * Returns: a #GtkRecentInfo. Use gtk_recent_info_unref() when * when you have finished using it. * * Since: 2.10 @@ -753,7 +753,7 @@ gtk_recent_chooser_get_current_item (GtkRecentChooser *chooser) * * Selects @uri inside @chooser. * - * Return value: %TRUE if @uri was found. + * Returns: %TRUE if @uri was found. * * Since: 2.10 */ @@ -827,7 +827,7 @@ gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser) * The return value of this function is affected by the “sort-type” and * “limit” properties of @chooser. * - * Return value: (element-type GtkRecentInfo) (transfer full): A newly allocated + * Returns: (element-type GtkRecentInfo) (transfer full): A newly allocated * list of #GtkRecentInfo objects. You should * use gtk_recent_info_unref() on every item of the list, and then free * the list itself using g_list_free(). @@ -855,7 +855,7 @@ gtk_recent_chooser_get_items (GtkRecentChooser *chooser) * * Since the returned array is %NULL terminated, @length may be %NULL. * - * Return value: (array length=length zero-terminated=1) (transfer full): + * Returns: (array length=length zero-terminated=1) (transfer full): * A newly allocated, %NULL-terminated array of strings. Use * g_strfreev() to free it. * @@ -943,7 +943,7 @@ gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser, * * Gets the #GtkRecentFilter objects held by @chooser. * - * Return value: (element-type GtkRecentFilter) (transfer container): A singly linked list + * Returns: (element-type GtkRecentFilter) (transfer container): A singly linked list * of #GtkRecentFilter objects. You * should just free the returned list using g_slist_free(). * @@ -984,7 +984,7 @@ gtk_recent_chooser_set_filter (GtkRecentChooser *chooser, * Gets the #GtkRecentFilter object currently used by @chooser to affect * the display of the recently used resources. * - * Return value: (transfer none): a #GtkRecentFilter object. + * Returns: (transfer none): a #GtkRecentFilter object. * * Since: 2.10 */ diff --git a/gtk/gtkrecentchooserdialog.c b/gtk/gtkrecentchooserdialog.c index 00382f3aea..f4a3043db4 100644 --- a/gtk/gtkrecentchooserdialog.c +++ b/gtk/gtkrecentchooserdialog.c @@ -315,7 +315,7 @@ gtk_recent_chooser_dialog_new_valist (const gchar *title, * Creates a new #GtkRecentChooserDialog. This function is analogous to * gtk_dialog_new_with_buttons(). * - * Return value: a new #GtkRecentChooserDialog + * Returns: a new #GtkRecentChooserDialog * * Since: 2.10 */ @@ -353,7 +353,7 @@ gtk_recent_chooser_dialog_new (const gchar *title, * This is useful if you have implemented your own recent manager, or if you * have a customized instance of a #GtkRecentManager object. * - * Return value: a new #GtkRecentChooserDialog + * Returns: a new #GtkRecentChooserDialog * * Since: 2.10 */ diff --git a/gtk/gtkrecentchoosermenu.c b/gtk/gtkrecentchoosermenu.c index ba512a4047..75c6cbf07c 100644 --- a/gtk/gtkrecentchoosermenu.c +++ b/gtk/gtkrecentchoosermenu.c @@ -1242,7 +1242,7 @@ gtk_recent_chooser_sync_action_properties (GtkActivatable *activatable, * gtk_recent_chooser_menu_new_for_manager() function to know how to create * a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object. * - * Return value: a new #GtkRecentChooserMenu + * Returns: a new #GtkRecentChooserMenu * * Since: 2.10 */ @@ -1266,7 +1266,7 @@ gtk_recent_chooser_menu_new (void) * object or if you wish to share a common #GtkRecentManager object * among multiple #GtkRecentChooser widgets. * - * Return value: a new #GtkRecentChooserMenu, bound to @manager. + * Returns: a new #GtkRecentChooserMenu, bound to @manager. * * Since: 2.10 */ @@ -1286,7 +1286,7 @@ gtk_recent_chooser_menu_new_for_manager (GtkRecentManager *manager) * * Returns the value set by gtk_recent_chooser_menu_set_show_numbers(). * - * Return value: %TRUE if numbers should be shown. + * Returns: %TRUE if numbers should be shown. * * Since: 2.10 */ diff --git a/gtk/gtkrecentchooserutils.c b/gtk/gtkrecentchooserutils.c index 98f2cd3d96..8e788b6dd3 100644 --- a/gtk/gtkrecentchooserutils.c +++ b/gtk/gtkrecentchooserutils.c @@ -408,7 +408,7 @@ get_is_recent_filtered (GtkRecentFilter *filter, * #GtkRecentChooser interface inside the GtkRecentChooser::get_items * vfunc. * - * Return value: a list of #GtkRecentInfo objects + * Returns: a list of #GtkRecentInfo objects */ GList * _gtk_recent_chooser_get_items (GtkRecentChooser *chooser, diff --git a/gtk/gtkrecentchooserwidget.c b/gtk/gtkrecentchooserwidget.c index d8fe8753e4..2209a07bad 100644 --- a/gtk/gtkrecentchooserwidget.c +++ b/gtk/gtkrecentchooserwidget.c @@ -156,7 +156,7 @@ gtk_recent_chooser_widget_init (GtkRecentChooserWidget *widget) * Creates a new #GtkRecentChooserWidget object. This is an embeddable widget * used to access the recently used resources list. * - * Return value: a new #GtkRecentChooserWidget + * Returns: a new #GtkRecentChooserWidget * * Since: 2.10 */ @@ -175,7 +175,7 @@ gtk_recent_chooser_widget_new (void) * This is useful if you have implemented your own recent manager, or if you * have a customized instance of a #GtkRecentManager object. * - * Return value: a new #GtkRecentChooserWidget + * Returns: a new #GtkRecentChooserWidget * * Since: 2.10 */ diff --git a/gtk/gtkrecentfilter.c b/gtk/gtkrecentfilter.c index 4f46073471..8b4f2f7c3a 100644 --- a/gtk/gtkrecentfilter.c +++ b/gtk/gtkrecentfilter.c @@ -406,7 +406,7 @@ gtk_recent_filter_buildable_custom_tag_end (GtkBuildable *buildable, * gtk_recent_filter_add_pattern (filter, "*"); * ]| * - * Return value: a new #GtkRecentFilter + * Returns: a new #GtkRecentFilter * * Since: 2.10 */ @@ -446,7 +446,7 @@ gtk_recent_filter_set_name (GtkRecentFilter *filter, * Gets the human-readable name for the filter. * See gtk_recent_filter_set_name(). * - * Return value: the name of the filter, or %NULL. The returned string + * Returns: the name of the filter, or %NULL. The returned string * is owned by the filter object and should not be freed. * * Since: 2.10 @@ -470,7 +470,7 @@ gtk_recent_filter_get_name (GtkRecentFilter *filter) * is intended principally for use in the implementation of * #GtkRecentChooser. * - * Return value: bitfield of flags indicating needed fields when + * Returns: bitfield of flags indicating needed fields when * calling gtk_recent_filter_filter() * * Since: 2.10 @@ -701,7 +701,7 @@ gtk_recent_filter_add_custom (GtkRecentFilter *filter, * is intended principally for use in the implementation of * #GtkRecentChooser. * - * Return value: %TRUE if the file should be displayed + * Returns: %TRUE if the file should be displayed * * Since: 2.10 */ diff --git a/gtk/gtkrecentfilter.h b/gtk/gtkrecentfilter.h index 1a0f8b90c5..32d6bf156f 100644 --- a/gtk/gtkrecentfilter.h +++ b/gtk/gtkrecentfilter.h @@ -68,7 +68,7 @@ typedef enum { * The type of function that is used with custom filters, * see gtk_recent_filter_add_custom(). * - * Return value: %TRUE if the file should be displayed + * Returns: %TRUE if the file should be displayed */ typedef gboolean (*GtkRecentFilterFunc) (const GtkRecentFilterInfo *filter_info, gpointer user_data); diff --git a/gtk/gtkrecentmanager.c b/gtk/gtkrecentmanager.c index dab8583da0..fd49bac9eb 100644 --- a/gtk/gtkrecentmanager.c +++ b/gtk/gtkrecentmanager.c @@ -713,7 +713,7 @@ build_recent_items_list (GtkRecentManager *manager) * #GtkRecentManager objects are expensive: be sure to create them only when * needed. You should use gtk_recent_manager_get_default() instead. * - * Return value: A newly created #GtkRecentManager object. + * Returns: A newly created #GtkRecentManager object. * * Since: 2.10 */ @@ -729,7 +729,7 @@ gtk_recent_manager_new (void) * Gets a unique instance of #GtkRecentManager, that you can share * in your application without caring about memory management. * - * Return value: (transfer none): A unique #GtkRecentManager. Do not ref or unref it. + * Returns: (transfer none): A unique #GtkRecentManager. Do not ref or unref it. * * Since: 2.10 */ @@ -821,7 +821,7 @@ gtk_recent_manager_add_item_query_info (GObject *source_object, * See gtk_recent_manager_add_full() if you want to explicitly * define the metadata for the resource pointed by @uri. * - * Return value: %TRUE if the new item was successfully added + * Returns: %TRUE if the new item was successfully added * to the recently used resources list * * Since: 2.10 @@ -876,7 +876,7 @@ gtk_recent_manager_add_item (GtkRecentManager *manager, * considered private - that is, should be displayed only by the * applications that have registered it. * - * Return value: %TRUE if the new item was successfully added to the + * Returns: %TRUE if the new item was successfully added to the * recently used resources list, %FALSE otherwise. * * Since: 2.10 @@ -1000,7 +1000,7 @@ gtk_recent_manager_add_full (GtkRecentManager *manager, * Removes a resource pointed by @uri from the recently used resources * list handled by a recent manager. * - * Return value: %TRUE if the item pointed by @uri has been successfully + * Returns: %TRUE if the item pointed by @uri has been successfully * removed by the recently used resources list, and %FALSE otherwise. * * Since: 2.10 @@ -1059,7 +1059,7 @@ gtk_recent_manager_remove_item (GtkRecentManager *manager, * Checks whether there is a recently used resource registered * with @uri inside the recent manager. * - * Return value: %TRUE if the resource was found, %FALSE otherwise. + * Returns: %TRUE if the resource was found, %FALSE otherwise. * * Since: 2.10 */ @@ -1149,7 +1149,7 @@ build_recent_info (GBookmarkFile *bookmarks, * returns a #GtkRecentInfo-struct containing informations about the resource * like its MIME type, or its display name. * - * Return value: a #GtkRecentInfo-struct containing information + * Returns: a #GtkRecentInfo-struct containing information * about the resource pointed by @uri, or %NULL if the URI was * not registered in the recently used resources list. Free with * gtk_recent_info_unref(). @@ -1215,7 +1215,7 @@ gtk_recent_manager_lookup_item (GtkRecentManager *manager, * Please note that this function will not affect the resource pointed * by the URIs, but only the URI used in the recently used resources list. * - * Return value: %TRUE on success. + * Returns: %TRUE on success. * * Since: 2.10 */ @@ -1279,7 +1279,7 @@ gtk_recent_manager_move_item (GtkRecentManager *recent_manager, * * Gets the list of recently used resources. * - * Return value: (element-type GtkRecentInfo) (transfer full): a list of + * Returns: (element-type GtkRecentInfo) (transfer full): a list of * newly allocated #GtkRecentInfo objects. Use * gtk_recent_info_unref() on each item inside the list, and then * free the list itself using g_list_free(). @@ -1341,7 +1341,7 @@ purge_recent_items_list (GtkRecentManager *manager, * * Purges every item from the recently used resources list. * - * Return value: the number of items that have been removed from the + * Returns: the number of items that have been removed from the * recently used resources list. * * Since: 2.10 @@ -1517,7 +1517,7 @@ gtk_recent_info_free (GtkRecentInfo *recent_info) * * Increases the reference count of @recent_info by one. * - * Return value: the recent info object with its reference count increased + * Returns: the recent info object with its reference count increased * by one. * * Since: 2.10 @@ -1560,7 +1560,7 @@ gtk_recent_info_unref (GtkRecentInfo *info) * * Gets the URI of the resource. * - * Return value: the URI of the resource. The returned string is + * Returns: the URI of the resource. The returned string is * owned by the recent manager, and should not be freed. * * Since: 2.10 @@ -1580,7 +1580,7 @@ gtk_recent_info_get_uri (GtkRecentInfo *info) * Gets the name of the resource. If none has been defined, the basename * of the resource is obtained. * - * Return value: the display name of the resource. The returned string + * Returns: the display name of the resource. The returned string * is owned by the recent manager, and should not be freed. * * Since: 2.10 @@ -1602,7 +1602,7 @@ gtk_recent_info_get_display_name (GtkRecentInfo *info) * * Gets the (short) description of the resource. * - * Return value: the description of the resource. The returned string + * Returns: the description of the resource. The returned string * is owned by the recent manager, and should not be freed. * * Since: 2.10 @@ -1621,7 +1621,7 @@ gtk_recent_info_get_description (GtkRecentInfo *info) * * Gets the MIME type of the resource. * - * Return value: the MIME type of the resource. The returned string + * Returns: the MIME type of the resource. The returned string * is owned by the recent manager, and should not be freed. * * Since: 2.10 @@ -1644,7 +1644,7 @@ gtk_recent_info_get_mime_type (GtkRecentInfo *info) * Gets the timestamp (seconds from system’s Epoch) when the resource * was added to the recently used resources list. * - * Return value: the number of seconds elapsed from system’s Epoch when + * Returns: the number of seconds elapsed from system’s Epoch when * the resource was added to the list, or -1 on failure. * * Since: 2.10 @@ -1664,7 +1664,7 @@ gtk_recent_info_get_added (GtkRecentInfo *info) * Gets the timestamp (seconds from system’s Epoch) when the meta-data * for the resource was last modified. * - * Return value: the number of seconds elapsed from system’s Epoch when + * Returns: the number of seconds elapsed from system’s Epoch when * the resource was last modified, or -1 on failure. * * Since: 2.10 @@ -1684,7 +1684,7 @@ gtk_recent_info_get_modified (GtkRecentInfo *info) * Gets the timestamp (seconds from system’s Epoch) when the meta-data * for the resource was last visited. * - * Return value: the number of seconds elapsed from system’s Epoch when + * Returns: the number of seconds elapsed from system’s Epoch when * the resource was last visited, or -1 on failure. * * Since: 2.10 @@ -1705,7 +1705,7 @@ gtk_recent_info_get_visited (GtkRecentInfo *info) * list that have this flag set to %TRUE should only be displayed by the * applications that have registered them. * - * Return value: %TRUE if the private flag was found, %FALSE otherwise. + * Returns: %TRUE if the private flag was found, %FALSE otherwise. * * Since: 2.10 */ @@ -1761,7 +1761,7 @@ recent_app_info_free (RecentAppInfo *app_info) * If the command line contains any escape characters defined inside the * storage specification, they will be expanded. * - * Return value: %TRUE if an application with @app_name has registered this + * Returns: %TRUE if an application with @app_name has registered this * resource inside the recently used list, or %FALSE otherwise. The * @app_exec string is owned by the #GtkRecentInfo and should not be * modified or freed @@ -1810,7 +1810,7 @@ gtk_recent_info_get_application_info (GtkRecentInfo *info, * * Retrieves the list of applications that have registered this resource. * - * Return value: (array length=length zero-terminated=1) (transfer full): + * Returns: (array length=length zero-terminated=1) (transfer full): * a newly allocated %NULL-terminated array of strings. * Use g_strfreev() to free it. * @@ -1863,7 +1863,7 @@ gtk_recent_info_get_applications (GtkRecentInfo *info, * * Checks whether an application registered this resource using @app_name. * - * Return value: %TRUE if an application with name @app_name was found, + * Returns: %TRUE if an application with name @app_name was found, * %FALSE otherwise. * * Since: 2.10 @@ -1885,7 +1885,7 @@ gtk_recent_info_has_application (GtkRecentInfo *info, * Gets the name of the last application that have registered the * recently used resource represented by @info. * - * Return value: an application name. Use g_free() to free it. + * Returns: an application name. Use g_free() to free it. * * Since: 2.10 */ @@ -1971,7 +1971,7 @@ get_icon_fallback (const gchar *icon_name, * * Retrieves the icon of size @size associated to the resource MIME type. * - * Return value: (transfer full): a #GdkPixbuf containing the icon, + * Returns: (transfer full): a #GdkPixbuf containing the icon, * or %NULL. Use g_object_unref() when finished using the icon. * * Since: 2.10 @@ -2006,7 +2006,7 @@ gtk_recent_info_get_icon (GtkRecentInfo *info, * * Retrieves the icon associated to the resource MIME type. * - * Return value: (transfer full): a #GIcon containing the icon, or %NULL. Use + * Returns: (transfer full): a #GIcon containing the icon, or %NULL. Use * g_object_unref() when finished using the icon * * Since: 2.22 @@ -2036,7 +2036,7 @@ gtk_recent_info_get_gicon (GtkRecentInfo *info) * Checks whether the resource is local or not by looking at the * scheme of its URI. * - * Return value: %TRUE if the resource is local. + * Returns: %TRUE if the resource is local. * * Since: 2.10 */ @@ -2055,7 +2055,7 @@ gtk_recent_info_is_local (GtkRecentInfo *info) * Checks whether the resource pointed by @info still exists. At * the moment this check is done only on resources pointing to local files. * - * Return value: %TRUE if the resource exists + * Returns: %TRUE if the resource exists * * Since: 2.10 */ @@ -2092,7 +2092,7 @@ gtk_recent_info_exists (GtkRecentInfo *info) * Checks whether two #GtkRecentInfo-struct point to the same * resource. * - * Return value: %TRUE if both #GtkRecentInfo-struct point to se same + * Returns: %TRUE if both #GtkRecentInfo-struct point to se same * resource, %FALSE otherwise. * * Since: 2.10 @@ -2239,7 +2239,7 @@ get_uri_shortname_for_display (const gchar *uri) * menu or list. For example, calling this function on an item that refers to * “file:///foo/bar.txt” will yield “bar.txt”. * - * Return value: A newly-allocated string in UTF-8 encoding; free it with + * Returns: A newly-allocated string in UTF-8 encoding; free it with * g_free(). * * Since: 2.10 @@ -2267,7 +2267,7 @@ gtk_recent_info_get_short_name (GtkRecentInfo *info) * is local, it returns a local path; if the resource is not local, * it returns the UTF-8 encoded content of gtk_recent_info_get_uri(). * - * Return value: a newly allocated UTF-8 string containing the + * Returns: a newly allocated UTF-8 string containing the * resource’s URI or %NULL. Use g_free() when done using it. * * Since: 2.10 @@ -2306,7 +2306,7 @@ gtk_recent_info_get_uri_display (GtkRecentInfo *info) * Gets the number of days elapsed since the last update of the resource * pointed by @info. * - * Return value: a positive integer containing the number of days elapsed + * Returns: a positive integer containing the number of days elapsed * since the time this resource was last modified. * * Since: 2.10 @@ -2337,7 +2337,7 @@ gtk_recent_info_get_age (GtkRecentInfo *info) * array of returned group names will be %NULL terminated, so length might * optionally be %NULL. * - * Return value: (array length=length zero-terminated=1) (transfer full): + * Returns: (array length=length zero-terminated=1) (transfer full): * a newly allocated %NULL terminated array of strings. * Use g_strfreev() to free it. * @@ -2391,7 +2391,7 @@ gtk_recent_info_get_groups (GtkRecentInfo *info, * Checks whether @group_name appears inside the groups registered for the * recently used item @info. * - * Return value: %TRUE if the group was found. + * Returns: %TRUE if the group was found. * * Since: 2.10 */ @@ -2428,7 +2428,7 @@ gtk_recent_info_has_group (GtkRecentInfo *info, * * Creates a #GAppInfo for the specified #GtkRecentInfo * - * Return value: (transfer full): the newly created #GAppInfo, or %NULL. + * Returns: (transfer full): the newly created #GAppInfo, or %NULL. * In case of error, @error will be set either with a * %GTK_RECENT_MANAGER_ERROR or a %G_IO_ERROR */ diff --git a/gtk/gtkrevealer.c b/gtk/gtkrevealer.c index cd9c7a2e09..32b6668c46 100644 --- a/gtk/gtkrevealer.c +++ b/gtk/gtkrevealer.c @@ -687,7 +687,7 @@ gtk_revealer_set_reveal_child (GtkRevealer *revealer, * the child is fully revealed (ie the transition is completed), * use gtk_revealer_get_child_revealed(). * - * Return value: %TRUE if the child is revealed. + * Returns: %TRUE if the child is revealed. * * Since: 3.10 */ @@ -708,7 +708,7 @@ gtk_revealer_get_reveal_child (GtkRevealer *revealer) * Returns whether the child is fully revealed, ie wether * the transition to the revealed state is completed. * - * Return value: %TRUE if the child is fully revealed + * Returns: %TRUE if the child is fully revealed * * Since: 3.10 */ @@ -890,7 +890,7 @@ gtk_revealer_set_transition_duration (GtkRevealer *revealer, * Gets the type of animation that will be used * for transitions in @revealer. * - * Return value: the current transition type of @revealer + * Returns: the current transition type of @revealer * * Since: 3.10 */ diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c index 5a6acab970..435f877b18 100644 --- a/gtk/gtkscale.c +++ b/gtk/gtkscale.c @@ -291,7 +291,7 @@ gtk_scale_class_init (GtkScaleClass *class) * } * ]| * - * Return value: allocated string representing @value + * Returns: allocated string representing @value */ signals[FORMAT_VALUE] = g_signal_new (I_("format-value"), @@ -573,7 +573,7 @@ gtk_scale_get_property (GObject *object, * * Creates a new #GtkScale. * - * Return value: a new #GtkScale + * Returns: a new #GtkScale * * Since: 3.0 **/ @@ -607,7 +607,7 @@ gtk_scale_new (GtkOrientation orientation, * is a power of ten. If the resulting precision is not suitable for your * needs, use gtk_scale_set_digits() to correct it. * - * Return value: a new #GtkScale + * Returns: a new #GtkScale * * Since: 3.0 */ @@ -1410,7 +1410,7 @@ gtk_scale_real_get_layout_offsets (GtkScale *scale, * Emits #GtkScale::format-value signal to format the value, * if no user signal handlers, falls back to a default format. * - * Return value: formatted value + * Returns: formatted value */ gchar* _gtk_scale_format_value (GtkScale *scale, @@ -1450,7 +1450,7 @@ gtk_scale_finalize (GObject *object) * object is owned by the scale so does not need to be freed by * the caller. * - * Return value: (transfer none): the #PangoLayout for this scale, + * Returns: (transfer none): the #PangoLayout for this scale, * or %NULL if the #GtkScale:draw-value property is %FALSE. * * Since: 2.4 diff --git a/gtk/gtkscalebutton.c b/gtk/gtkscalebutton.c index 3f1eea7ce9..4ef8a45089 100644 --- a/gtk/gtkscalebutton.c +++ b/gtk/gtkscalebutton.c @@ -516,7 +516,7 @@ gtk_scale_button_dispose (GObject *object) * Creates a #GtkScaleButton, with a range between @min and @max, with * a stepping of @step. * - * Return value: a new #GtkScaleButton + * Returns: a new #GtkScaleButton * * Since: 2.12 */ @@ -547,7 +547,7 @@ gtk_scale_button_new (GtkIconSize size, * * Gets the current value of the scale button. * - * Return value: current value of the scale button + * Returns: current value of the scale button * * Since: 2.12 */ diff --git a/gtk/gtkscrollable.c b/gtk/gtkscrollable.c index 68acbedea7..94c558559d 100644 --- a/gtk/gtkscrollable.c +++ b/gtk/gtkscrollable.c @@ -138,7 +138,7 @@ gtk_scrollable_default_init (GtkScrollableInterface *iface) * * Retrieves the #GtkAdjustment used for horizontal scrolling. * - * Return value: (transfer none): horizontal #GtkAdjustment. + * Returns: (transfer none): horizontal #GtkAdjustment. * * Since: 3.0 **/ @@ -186,7 +186,7 @@ gtk_scrollable_set_hadjustment (GtkScrollable *scrollable, * * Retrieves the #GtkAdjustment used for vertical scrolling. * - * Return value: (transfer none): vertical #GtkAdjustment. + * Returns: (transfer none): vertical #GtkAdjustment. * * Since: 3.0 **/ @@ -235,7 +235,7 @@ gtk_scrollable_set_vadjustment (GtkScrollable *scrollable, * * Gets the horizontal #GtkScrollablePolicy. * - * Return value: The horizontal #GtkScrollablePolicy. + * Returns: The horizontal #GtkScrollablePolicy. * * Since: 3.0 **/ @@ -277,7 +277,7 @@ gtk_scrollable_set_hscroll_policy (GtkScrollable *scrollable, * * Gets the vertical #GtkScrollablePolicy. * - * Return value: The vertical #GtkScrollablePolicy. + * Returns: The vertical #GtkScrollablePolicy. * * Since: 3.0 **/ diff --git a/gtk/gtkscrollbar.c b/gtk/gtkscrollbar.c index 4fe7c87aea..2fbbeba93f 100644 --- a/gtk/gtkscrollbar.c +++ b/gtk/gtkscrollbar.c @@ -160,7 +160,7 @@ gtk_scrollbar_style_updated (GtkWidget *widget) * * Creates a new scrollbar with the given orientation. * - * Return value: the new #GtkScrollbar. + * Returns: the new #GtkScrollbar. * * Since: 3.0 **/ diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c index 0840ff0125..b93689cb51 100644 --- a/gtk/gtkscrolledwindow.c +++ b/gtk/gtkscrolledwindow.c @@ -954,7 +954,7 @@ gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window, * Gets the placement of the contents with respect to the scrollbars * for the scrolled window. See gtk_scrolled_window_set_placement(). * - * Return value: the current placement value. + * Returns: the current placement value. * * See also gtk_scrolled_window_set_placement() and * gtk_scrolled_window_unset_placement(). @@ -1028,7 +1028,7 @@ gtk_scrolled_window_set_shadow_type (GtkScrolledWindow *scrolled_window, * Gets the shadow type of the scrolled window. See * gtk_scrolled_window_set_shadow_type(). * - * Return value: the current shadow type + * Returns: the current shadow type **/ GtkShadowType gtk_scrolled_window_get_shadow_type (GtkScrolledWindow *scrolled_window) @@ -1090,7 +1090,7 @@ gtk_scrolled_window_set_kinetic_scrolling (GtkScrolledWindow *scrolled_window, * * Returns the specified kinetic scrolling behavior. * - * Return value: the scrolling behavior flags. + * Returns: the scrolling behavior flags. * * Since: 3.4 */ @@ -3043,7 +3043,7 @@ gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrolled_window, * Gets the spacing between the scrolled window’s scrollbars and * the scrolled widget. Used by GtkCombo * - * Return value: the spacing, in pixels. + * Returns: the spacing, in pixels. */ gint _gtk_scrolled_window_get_scrollbar_spacing (GtkScrolledWindow *scrolled_window) diff --git a/gtk/gtksearchbar.c b/gtk/gtksearchbar.c index 23f76cc3fc..8104abef12 100644 --- a/gtk/gtksearchbar.c +++ b/gtk/gtksearchbar.c @@ -179,7 +179,7 @@ preedit_changed_cb (GtkEntry *entry, * search_bar); * ]| * - * Return value: %GDK_EVENT_STOP if the key press event resulted + * Returns: %GDK_EVENT_STOP if the key press event resulted * in text being entered in the search entry (and revealing * the search bar if necessary), %GDK_EVENT_PROPAGATE otherwise. * @@ -455,7 +455,7 @@ gtk_search_bar_init (GtkSearchBar *bar) * which widget is going to be your text entry using * gtk_search_bar_connect_entry(). * - * Return value: a new #GtkSearchBar + * Returns: a new #GtkSearchBar * * Since: 3.10 */ @@ -508,7 +508,7 @@ gtk_search_bar_connect_entry (GtkSearchBar *bar, * * Returns whether the search mode is on or off. * - * Return value: whether search mode is toggled on + * Returns: whether search mode is toggled on * * Since: 3.10 */ @@ -548,7 +548,7 @@ gtk_search_bar_set_search_mode (GtkSearchBar *bar, * * Returns whether the close button is shown. * - * Return value: whether the close button is shown + * Returns: whether the close button is shown * * Since: 3.10 */ diff --git a/gtk/gtksearchentry.c b/gtk/gtksearchentry.c index 57e88b3baf..a43f7c7ee8 100644 --- a/gtk/gtksearchentry.c +++ b/gtk/gtksearchentry.c @@ -247,7 +247,7 @@ gtk_search_entry_init (GtkSearchEntry *entry) * Creates a #GtkSearchEntry, with a find icon when the search field is * empty, and a clear icon when it isn't. * - * Return value: a new #GtkSearchEntry + * Returns: a new #GtkSearchEntry * * Since: 3.6 */ diff --git a/gtk/gtkselection.c b/gtk/gtkselection.c index 925d5ff9e5..f08a5c3da5 100644 --- a/gtk/gtkselection.c +++ b/gtk/gtkselection.c @@ -219,7 +219,7 @@ static const char gtk_selection_handler_key[] = "gtk-selection-handlers"; * * Creates a new #GtkTargetList from an array of #GtkTargetEntry. * - * Return value: (transfer full): the new #GtkTargetList. + * Returns: (transfer full): the new #GtkTargetList. **/ GtkTargetList * gtk_target_list_new (const GtkTargetEntry *targets, @@ -241,7 +241,7 @@ gtk_target_list_new (const GtkTargetEntry *targets, * * Increases the reference count of a #GtkTargetList by one. * - * Return value: the passed in #GtkTargetList. + * Returns: the passed in #GtkTargetList. **/ GtkTargetList * gtk_target_list_ref (GtkTargetList *list) @@ -563,7 +563,7 @@ gtk_target_list_remove (GtkTargetList *list, * * Looks up a given target in a #GtkTargetList. * - * Return value: %TRUE if the target was found, otherwise %FALSE + * Returns: %TRUE if the target was found, otherwise %FALSE **/ gboolean gtk_target_list_find (GtkTargetList *list, @@ -603,7 +603,7 @@ gtk_target_list_find (GtkTargetList *list, * allocated and should be freed using gtk_target_table_free() when no * longer needed. * - * Return value: (array length=n_targets) (transfer full): the new table. + * Returns: (array length=n_targets) (transfer full): the new table. * * Since: 2.10 **/ @@ -669,7 +669,7 @@ gtk_target_table_free (GtkTargetEntry *targets, * Claim ownership of a given selection for a particular widget, or, * if @widget is %NULL, release ownership of the selection. * - * Return value: TRUE if the operation succeeded + * Returns: TRUE if the operation succeeded * * Since: 2.2 */ @@ -771,7 +771,7 @@ gtk_selection_owner_set_for_display (GdkDisplay *display, * Claims ownership of a given selection for a particular widget, * or, if @widget is %NULL, release ownership of the selection. * - * Return value: %TRUE if the operation succeeded + * Returns: %TRUE if the operation succeeded **/ gboolean gtk_selection_owner_set (GtkWidget *widget, @@ -1037,7 +1037,7 @@ gtk_selection_remove_all (GtkWidget *widget) * Requests the contents of a selection. When received, * a “selection-received” signal will be generated. * - * Return value: %TRUE if requested succeeded. %FALSE if we could not process + * Returns: %TRUE if requested succeeded. %FALSE if we could not process * request. (e.g., there was already a request in process for * this widget). **/ @@ -1544,7 +1544,7 @@ selection_get_text_plain (const GtkSelectionData *selection_data) * The string is converted to the form determined by * @selection_data->target. * - * Return value: %TRUE if the selection was successfully set, + * Returns: %TRUE if the selection was successfully set, * otherwise %FALSE. **/ gboolean @@ -1594,7 +1594,7 @@ gtk_selection_data_set_text (GtkSelectionData *selection_data, * * Gets the contents of the selection data as a UTF-8 string. * - * Return value: (type utf8): if the selection data contained a + * Returns: (type utf8): if the selection data contained a * recognized text type and it could be converted to UTF-8, a newly * allocated string containing the converted text, otherwise %NULL. * If the result is non-%NULL it must be freed with g_free(). @@ -1648,7 +1648,7 @@ gtk_selection_data_get_text (const GtkSelectionData *selection_data) * The pixbuf is converted to the form determined by * @selection_data->target. * - * Return value: %TRUE if the selection was successfully set, + * Returns: %TRUE if the selection was successfully set, * otherwise %FALSE. * * Since: 2.6 @@ -1712,7 +1712,7 @@ gtk_selection_data_set_pixbuf (GtkSelectionData *selection_data, * * Gets the contents of the selection data as a #GdkPixbuf. * - * Return value: (transfer full): if the selection data contained a recognized + * Returns: (transfer full): if the selection data contained a recognized * image type and it could be converted to a #GdkPixbuf, a * newly allocated pixbuf is returned, otherwise %NULL. * If the result is non-%NULL it must be freed with g_object_unref(). @@ -1757,7 +1757,7 @@ gtk_selection_data_get_pixbuf (const GtkSelectionData *selection_data) * The string is converted to the form determined by * @selection_data->target. * - * Return value: %TRUE if the selection was successfully set, + * Returns: %TRUE if the selection was successfully set, * otherwise %FALSE. * * Since: 2.6 @@ -1811,7 +1811,7 @@ gtk_selection_data_set_uris (GtkSelectionData *selection_data, * * Gets the contents of the selection data as array of URIs. * - * Return value: (array zero-terminated=1) (element-type utf8) (transfer full): if + * Returns: (array zero-terminated=1) (element-type utf8) (transfer full): if * the selection data contains a list of * URIs, a newly allocated %NULL-terminated string array * containing the URIs, otherwise %NULL. If the result is @@ -1861,7 +1861,7 @@ gtk_selection_data_get_uris (const GtkSelectionData *selection_data) * the standard TARGETS target that is always supplied for * any selection. * - * Return value: %TRUE if @selection_data contains a valid + * Returns: %TRUE if @selection_data contains a valid * array of targets, otherwise %FALSE. **/ gboolean @@ -1901,7 +1901,7 @@ gtk_selection_data_get_targets (const GtkSelectionData *selection_data, * Determines if any of the targets in @targets can be used to * provide text. * - * Return value: %TRUE if @targets include a suitable target for text, + * Returns: %TRUE if @targets include a suitable target for text, * otherwise %FALSE. * * Since: 2.10 @@ -1947,7 +1947,7 @@ gtk_targets_include_text (GdkAtom *targets, * Determines if any of the targets in @targets can be used to * provide rich text. * - * Return value: %TRUE if @targets include a suitable target for rich text, + * Returns: %TRUE if @targets include a suitable target for rich text, * otherwise %FALSE. * * Since: 2.10 @@ -1996,7 +1996,7 @@ gtk_targets_include_rich_text (GdkAtom *targets, * determines if any of the targets in @targets can be used to * provide text. * - * Return value: %TRUE if @selection_data holds a list of targets, + * Returns: %TRUE if @selection_data holds a list of targets, * and a suitable target for text is included, otherwise %FALSE. **/ gboolean @@ -2028,7 +2028,7 @@ gtk_selection_data_targets_include_text (const GtkSelectionData *selection_data) * determines if any of the targets in @targets can be used to * provide rich text. * - * Return value: %TRUE if @selection_data holds a list of targets, + * Returns: %TRUE if @selection_data holds a list of targets, * and a suitable target for rich text is included, * otherwise %FALSE. * @@ -2066,7 +2066,7 @@ gtk_selection_data_targets_include_rich_text (const GtkSelectionData *selection_ * Determines if any of the targets in @targets can be used to * provide a #GdkPixbuf. * - * Return value: %TRUE if @targets include a suitable target for images, + * Returns: %TRUE if @targets include a suitable target for images, * otherwise %FALSE. * * Since: 2.10 @@ -2112,7 +2112,7 @@ gtk_targets_include_image (GdkAtom *targets, * determines if any of the targets in @targets can be used to * provide a #GdkPixbuf. * - * Return value: %TRUE if @selection_data holds a list of targets, + * Returns: %TRUE if @selection_data holds a list of targets, * and a suitable target for images is included, otherwise %FALSE. * * Since: 2.6 @@ -2146,7 +2146,7 @@ gtk_selection_data_targets_include_image (const GtkSelectionData *selection_data * Determines if any of the targets in @targets can be used to * provide an uri list. * - * Return value: %TRUE if @targets include a suitable target for uri lists, + * Returns: %TRUE if @targets include a suitable target for uri lists, * otherwise %FALSE. * * Since: 2.10 @@ -2185,7 +2185,7 @@ gtk_targets_include_uri (GdkAtom *targets, * determines if any of the targets in @targets can be used to * provide a list or URIs. * - * Return value: %TRUE if @selection_data holds a list of targets, + * Returns: %TRUE if @selection_data holds a list of targets, * and a suitable target for URI lists is included, otherwise %FALSE. * * Since: 2.10 @@ -2239,7 +2239,7 @@ gtk_selection_init (void) * The default handler for the #GtkWidget::selection-clear-event * signal. * - * Return value: %TRUE if the event was handled, otherwise false + * Returns: %TRUE if the event was handled, otherwise false **/ gboolean _gtk_selection_clear (GtkWidget *widget, @@ -3132,7 +3132,7 @@ gtk_selection_default_handler (GtkWidget *widget, * * Makes a copy of a #GtkSelectionData-struct and its data. * - * Return value: a pointer to a copy of @data. + * Returns: a pointer to a copy of @data. **/ GtkSelectionData* gtk_selection_data_copy (const GtkSelectionData *data) @@ -3178,7 +3178,7 @@ gtk_selection_data_free (GtkSelectionData *data) * * Makes a new #GtkTargetEntry. * - * Return value: a pointer to a new #GtkTargetEntry. + * Returns: a pointer to a new #GtkTargetEntry. * Free with gtk_target_entry_free() **/ GtkTargetEntry * @@ -3196,7 +3196,7 @@ gtk_target_entry_new (const char *target, * * Makes a copy of a #GtkTargetEntry and its data. * - * Return value: a pointer to a copy of @data. + * Returns: a pointer to a copy of @data. * Free with gtk_target_entry_free() **/ GtkTargetEntry * diff --git a/gtk/gtkseparator.c b/gtk/gtkseparator.c index de887fb26d..acd24255f0 100644 --- a/gtk/gtkseparator.c +++ b/gtk/gtkseparator.c @@ -254,7 +254,7 @@ gtk_separator_draw (GtkWidget *widget, * * Creates a new #GtkSeparator with the given orientation. * - * Return value: a new #GtkSeparator. + * Returns: a new #GtkSeparator. * * Since: 3.0 */ diff --git a/gtk/gtkseparatortoolitem.c b/gtk/gtkseparatortoolitem.c index 0d9ed77b1b..006052cab7 100644 --- a/gtk/gtkseparatortoolitem.c +++ b/gtk/gtkseparatortoolitem.c @@ -385,7 +385,7 @@ gtk_separator_tool_item_draw (GtkWidget *widget, * * Create a new #GtkSeparatorToolItem * - * Return value: the new #GtkSeparatorToolItem + * Returns: the new #GtkSeparatorToolItem * * Since: 2.4 */ @@ -407,7 +407,7 @@ gtk_separator_tool_item_new (void) * Returns whether @item is drawn as a line, or just blank. * See gtk_separator_tool_item_set_draw(). * - * Return value: %TRUE if @item is drawn as a line, or just blank. + * Returns: %TRUE if @item is drawn as a line, or just blank. * * Since: 2.4 */ diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c index 52b7debb5c..0321047086 100644 --- a/gtk/gtksettings.c +++ b/gtk/gtksettings.c @@ -1726,7 +1726,7 @@ settings_init_style (GtkSettings *settings) * * Gets the #GtkSettings object for @screen, creating it if necessary. * - * Return value: (transfer none): a #GtkSettings object. + * Returns: (transfer none): a #GtkSettings object. * * Since: 2.2 */ @@ -1781,7 +1781,7 @@ gtk_settings_get_for_screen (GdkScreen *screen) * Gets the #GtkSettings object for the default GDK screen, creating * it if necessary. See gtk_settings_get_for_screen(). * - * Return value: (transfer none): a #GtkSettings object. If there is no default + * Returns: (transfer none): a #GtkSettings object. If there is no default * screen, then returns %NULL. **/ GtkSettings* @@ -2340,7 +2340,7 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS * blue are integers between 0 and 65535 or floating-point numbers * between 0 and 1. * - * Return value: %TRUE if @gstring could be parsed and @property_value + * Returns: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting #GdkColor. **/ gboolean @@ -2384,7 +2384,7 @@ gtk_rc_property_parse_color (const GParamSpec *pspec, * its numeric value. For consistency with flags parsing, the value * may be surrounded by parentheses. * - * Return value: %TRUE if @gstring could be parsed and @property_value + * Returns: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting #GEnumValue. **/ gboolean @@ -2479,7 +2479,7 @@ parse_flags_value (GScanner *scanner, * numerically. Multiple flags can be specified in the form * `"( flag1 | flag2 | ... )"`. * - * Return value: %TRUE if @gstring could be parsed and @property_value + * Returns: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting flags value. **/ gboolean @@ -2583,7 +2583,7 @@ get_braced_int (GScanner *scanner, * requisition in the form * `"{ width, height }"` for integers %width and %height. * - * Return value: %TRUE if @gstring could be parsed and @property_value + * Returns: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting #GtkRequisition. **/ gboolean @@ -2625,7 +2625,7 @@ gtk_rc_property_parse_requisition (const GParamSpec *pspec, * `"{ left, right, top, bottom }"` for integers * left, right, top and bottom. * - * Return value: %TRUE if @gstring could be parsed and @property_value + * Returns: %TRUE if @gstring could be parsed and @property_value * has been set to the resulting #GtkBorder. **/ gboolean diff --git a/gtk/gtksizegroup.c b/gtk/gtksizegroup.c index 9519ae9a24..159b59cccf 100644 --- a/gtk/gtksizegroup.c +++ b/gtk/gtksizegroup.c @@ -415,7 +415,7 @@ gtk_size_group_get_property (GObject *object, * * Create a new #GtkSizeGroup. - * Return value: a newly created #GtkSizeGroup + * Returns: a newly created #GtkSizeGroup **/ GtkSizeGroup * gtk_size_group_new (GtkSizeGroupMode mode) @@ -468,7 +468,7 @@ gtk_size_group_set_mode (GtkSizeGroup *size_group, * * Gets the current mode of the size group. See gtk_size_group_set_mode(). * - * Return value: the current mode of the size group. + * Returns: the current mode of the size group. **/ GtkSizeGroupMode gtk_size_group_get_mode (GtkSizeGroup *size_group) @@ -617,7 +617,7 @@ gtk_size_group_remove_widget (GtkSizeGroup *size_group, * * Returns the list of widgets associated with @size_group. * - * Return value: (element-type GtkWidget) (transfer none): a #GSList of + * Returns: (element-type GtkWidget) (transfer none): a #GSList of * widgets. The list is owned by GTK+ and should not be modified. * * Since: 2.10 diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c index 7250916bae..b59deb1370 100644 --- a/gtk/gtksocket.c +++ b/gtk/gtksocket.c @@ -241,7 +241,7 @@ gtk_socket_class_init (GtkSocketClass *class) * The default action is to destroy the #GtkSocket widget, so if you * want to reuse it you must add a signal handler that returns %TRUE. * - * Return value: %TRUE to stop other handlers from being invoked. + * Returns: %TRUE to stop other handlers from being invoked. */ socket_signals[PLUG_REMOVED] = g_signal_new (I_("plug-removed"), @@ -282,7 +282,7 @@ gtk_socket_init (GtkSocket *socket) * * Create a new empty #GtkSocket. * - * Return value: the new #GtkSocket. + * Returns: the new #GtkSocket. **/ GtkWidget* gtk_socket_new (void) @@ -336,7 +336,7 @@ gtk_socket_add_id (GtkSocket *socket, * The #GtkSocket must have already be added into a toplevel window * before you can make this call. * - * Return value: the window ID for the socket + * Returns: the window ID for the socket **/ Window gtk_socket_get_id (GtkSocket *socket) @@ -357,7 +357,7 @@ gtk_socket_get_id (GtkSocket *socket) * Retrieves the window of the plug. Use this to check if the plug has * been created inside of the socket. * - * Return value: (transfer none): the window of the plug if available, or %NULL + * Returns: (transfer none): the window of the plug if available, or %NULL * * Since: 2.14 **/ diff --git a/gtk/gtkspinbutton.c b/gtk/gtkspinbutton.c index b3b91d7195..db39c31ab6 100644 --- a/gtk/gtkspinbutton.c +++ b/gtk/gtkspinbutton.c @@ -2118,7 +2118,7 @@ gtk_spin_button_new (GtkAdjustment *adjustment, * is a power of ten. If the resulting precision is not suitable for your * needs, use gtk_spin_button_set_digits() to correct it. * - * Return value: The new spin button as a #GtkWidget + * Returns: The new spin button as a #GtkWidget */ GtkWidget * gtk_spin_button_new_with_range (gdouble min, @@ -2219,7 +2219,7 @@ gtk_spin_button_set_adjustment (GtkSpinButton *spin_button, * * Get the adjustment associated with a #GtkSpinButton * - * Return value: (transfer none): the #GtkAdjustment of @spin_button + * Returns: (transfer none): the #GtkAdjustment of @spin_button **/ GtkAdjustment * gtk_spin_button_get_adjustment (GtkSpinButton *spin_button) @@ -2392,7 +2392,7 @@ gtk_spin_button_get_range (GtkSpinButton *spin_button, * * Get the value in the @spin_button. * - * Return value: the value of @spin_button + * Returns: the value of @spin_button */ gdouble gtk_spin_button_get_value (GtkSpinButton *spin_button) @@ -2408,7 +2408,7 @@ gtk_spin_button_get_value (GtkSpinButton *spin_button) * * Get the value @spin_button represented as an integer. * - * Return value: the value of @spin_button + * Returns: the value of @spin_button */ gint gtk_spin_button_get_value_as_int (GtkSpinButton *spin_button) @@ -2488,7 +2488,7 @@ gtk_spin_button_set_update_policy (GtkSpinButton *spin_button, * Gets the update behavior of a spin button. * See gtk_spin_button_set_update_policy(). * - * Return value: the current update policy + * Returns: the current update policy */ GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button) @@ -2532,7 +2532,7 @@ gtk_spin_button_set_numeric (GtkSpinButton *spin_button, * Returns whether non-numeric text can be typed into the spin button. * See gtk_spin_button_set_numeric(). * - * Return value: %TRUE if only numeric text can be entered + * Returns: %TRUE if only numeric text can be entered */ gboolean gtk_spin_button_get_numeric (GtkSpinButton *spin_button) @@ -2579,7 +2579,7 @@ gtk_spin_button_set_wrap (GtkSpinButton *spin_button, * opposite limit when the upper or lower limit of the range is * exceeded. See gtk_spin_button_set_wrap(). * - * Return value: %TRUE if the spin button wraps around + * Returns: %TRUE if the spin button wraps around */ gboolean gtk_spin_button_get_wrap (GtkSpinButton *spin_button) @@ -2628,7 +2628,7 @@ gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button, * Returns whether the values are corrected to the nearest step. * See gtk_spin_button_set_snap_to_ticks(). * - * Return value: %TRUE if values are snapped to the nearest step + * Returns: %TRUE if values are snapped to the nearest step */ gboolean gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button) diff --git a/gtk/gtkspinner.c b/gtk/gtkspinner.c index ec882b1add..77f6e9a22c 100644 --- a/gtk/gtkspinner.c +++ b/gtk/gtkspinner.c @@ -247,7 +247,7 @@ gtk_spinner_set_active (GtkSpinner *spinner, * * Returns a new spinner widget. Not yet started. * - * Return value: a new #GtkSpinner + * Returns: a new #GtkSpinner * * Since: 2.20 */ diff --git a/gtk/gtkstack.c b/gtk/gtkstack.c index d21f316343..6d3a57a407 100644 --- a/gtk/gtkstack.c +++ b/gtk/gtkstack.c @@ -1142,7 +1142,7 @@ gtk_stack_remove (GtkContainer *container, * the argument. Returns %NULL if there is no child with this * name. * - * Return value: (transfer none): the requested child of the #GtkStack + * Returns: (transfer none): the requested child of the #GtkStack * * Since: 3.12 */ @@ -1207,7 +1207,7 @@ gtk_stack_set_homogeneous (GtkStack *stack, * Gets whether @stack is homogeneous. * See gtk_stack_set_homogeneous(). * - * Return value: whether @stack is homogeneous. + * Returns: whether @stack is homogeneous. * * Since: 3.10 */ @@ -1272,7 +1272,7 @@ gtk_stack_set_transition_duration (GtkStack *stack, * Gets the type of animation that will be used * for transitions between pages in @stack. * - * Return value: the current transition type of @stack + * Returns: the current transition type of @stack * * Since: 3.10 */ @@ -1321,7 +1321,7 @@ gtk_stack_set_transition_type (GtkStack *stack, * Returns whether the @stack is currently in a transition from one page to * another. * - * Return value: %TRUE if the transition is currently running, %FALSE otherwise. + * Returns: %TRUE if the transition is currently running, %FALSE otherwise. * * Since: 3.12 */ @@ -1342,7 +1342,7 @@ gtk_stack_get_transition_running (GtkStack *stack) * Gets the currently visible child of @stack, or %NULL if * there are no visible children. * - * Return value: (transfer none): the visible child of the #GtkStack + * Returns: (transfer none): the visible child of the #GtkStack * * Since: 3.10 */ @@ -1363,7 +1363,7 @@ gtk_stack_get_visible_child (GtkStack *stack) * Returns the name of the currently visible child of @stack, or * %NULL if there is no visible child. * - * Return value: (transfer none): the name of the visible child of the #GtkStack + * Returns: (transfer none): the name of the visible child of the #GtkStack * * Since: 3.10 */ diff --git a/gtk/gtkstackswitcher.c b/gtk/gtkstackswitcher.c index fdca8e91a0..83e2eed194 100644 --- a/gtk/gtkstackswitcher.c +++ b/gtk/gtkstackswitcher.c @@ -415,7 +415,7 @@ gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher, * Retrieves the stack. * See gtk_stack_switcher_set_stack(). * - * Return value: (transfer none): the stack, or %NULL if + * Returns: (transfer none): the stack, or %NULL if * none has been set explicitly. * * Since: 3.10 @@ -506,7 +506,7 @@ gtk_stack_switcher_class_init (GtkStackSwitcherClass *class) * * Create a new #GtkStackSwitcher. * - * Return value: a new #GtkStackSwitcher. + * Returns: a new #GtkStackSwitcher. * * Since: 3.10 */ diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c index 3607bb522a..a55996ab47 100644 --- a/gtk/gtkstatusicon.c +++ b/gtk/gtkstatusicon.c @@ -496,7 +496,7 @@ gtk_status_icon_class_init (GtkStatusIconClass *class) * Gets emitted when the size available for the image * changes, e.g. because the notification area got resized. * - * Return value: %TRUE if the icon was updated for the new + * Returns: %TRUE if the icon was updated for the new * size. Otherwise, GTK+ will scale the icon as necessary. * * Since: 2.10 @@ -525,7 +525,7 @@ gtk_status_icon_class_init (GtkStatusIconClass *class) * Whether this event is emitted is platform-dependent. Use the ::activate * and ::popup-menu signals in preference. * - * Return value: %TRUE to stop other handlers from being invoked + * Returns: %TRUE to stop other handlers from being invoked * for the event. %FALSE to propagate the event further. * * Since: 2.14 @@ -552,7 +552,7 @@ gtk_status_icon_class_init (GtkStatusIconClass *class) * Whether this event is emitted is platform-dependent. Use the ::activate * and ::popup-menu signals in preference. * - * Return value: %TRUE to stop other handlers from being invoked + * Returns: %TRUE to stop other handlers from being invoked * for the event. %FALSE to propagate the event further. * * Since: 2.14 @@ -1173,7 +1173,7 @@ gtk_status_icon_get_property (GObject *object, * * Creates an empty status icon object. * - * Return value: a new #GtkStatusIcon + * Returns: a new #GtkStatusIcon * * Since: 2.10 **/ @@ -1192,7 +1192,7 @@ gtk_status_icon_new (void) * The image will be scaled down to fit in the available * space in the notification area, if necessary. * - * Return value: a new #GtkStatusIcon + * Returns: a new #GtkStatusIcon * * Since: 2.10 **/ @@ -1213,7 +1213,7 @@ gtk_status_icon_new_from_pixbuf (GdkPixbuf *pixbuf) * The image will be scaled down to fit in the available * space in the notification area, if necessary. * - * Return value: a new #GtkStatusIcon + * Returns: a new #GtkStatusIcon * * Since: 2.10 **/ @@ -1234,7 +1234,7 @@ gtk_status_icon_new_from_file (const gchar *filename) * own stock icon names, see gtk_icon_factory_add_default() and * gtk_icon_factory_add(). * - * Return value: a new #GtkStatusIcon + * Returns: a new #GtkStatusIcon * * Since: 2.10 * @@ -1256,7 +1256,7 @@ gtk_status_icon_new_from_stock (const gchar *stock_id) * If the current icon theme is changed, the icon will be updated * appropriately. * - * Return value: a new #GtkStatusIcon + * Returns: a new #GtkStatusIcon * * Since: 2.10 **/ @@ -1275,7 +1275,7 @@ gtk_status_icon_new_from_icon_name (const gchar *icon_name) * Creates a status icon displaying a #GIcon. If the icon is a * themed icon, it will be updated when the theme changes. * - * Return value: a new #GtkStatusIcon + * Returns: a new #GtkStatusIcon * * Since: 2.14 **/ @@ -1849,7 +1849,7 @@ gtk_status_icon_set_from_gicon (GtkStatusIcon *status_icon, * to store image data. If the #GtkStatusIcon has no image data, * the return value will be %GTK_IMAGE_EMPTY. * - * Return value: the image representation being used + * Returns: the image representation being used * * Since: 2.10 **/ @@ -1870,7 +1870,7 @@ gtk_status_icon_get_storage_type (GtkStatusIcon *status_icon) * The caller of this function does not own a reference to the * returned pixbuf. * - * Return value: (transfer none): the displayed pixbuf, + * Returns: (transfer none): the displayed pixbuf, * or %NULL if the image is empty. * * Since: 2.10 @@ -1897,7 +1897,7 @@ gtk_status_icon_get_pixbuf (GtkStatusIcon *status_icon) * The returned string is owned by the #GtkStatusIcon and should not * be freed or modified. * - * Return value: stock id of the displayed stock icon, + * Returns: stock id of the displayed stock icon, * or %NULL if the image is empty. * * Since: 2.10 @@ -1926,7 +1926,7 @@ gtk_status_icon_get_stock (GtkStatusIcon *status_icon) * The returned string is owned by the #GtkStatusIcon and should not * be freed or modified. * - * Return value: name of the displayed icon, or %NULL if the image is empty. + * Returns: name of the displayed icon, or %NULL if the image is empty. * * Since: 2.10 **/ @@ -1983,7 +1983,7 @@ gtk_status_icon_get_gicon (GtkStatusIcon *status_icon) * Note that the returned size is only meaningful while the * status icon is embedded (see gtk_status_icon_is_embedded()). * - * Return value: the size that is available for the image + * Returns: the size that is available for the image * * Since: 2.10 **/ @@ -2024,7 +2024,7 @@ gtk_status_icon_set_screen (GtkStatusIcon *status_icon, * * Returns the #GdkScreen associated with @status_icon. * - * Return value: (transfer none): a #GdkScreen. + * Returns: (transfer none): a #GdkScreen. * * Since: 2.12 */ @@ -2105,7 +2105,7 @@ gtk_status_icon_set_visible (GtkStatusIcon *status_icon, * the user can actually see the icon, see also * gtk_status_icon_is_embedded(). * - * Return value: %TRUE if the status icon is visible + * Returns: %TRUE if the status icon is visible * * Since: 2.10 **/ @@ -2124,7 +2124,7 @@ gtk_status_icon_get_visible (GtkStatusIcon *status_icon) * Returns whether the status icon is embedded in a notification * area. * - * Return value: %TRUE if the status icon is embedded in + * Returns: %TRUE if the status icon is embedded in * a notification area. * * Since: 2.10 @@ -2311,7 +2311,7 @@ gtk_status_icon_position_menu (GtkMenu *menu, * is embedded in a notification area, see * gtk_status_icon_is_embedded(). * - * Return value: %TRUE if the location information has + * Returns: %TRUE if the location information has * been filled in * * Since: 2.10 @@ -2400,7 +2400,7 @@ gtk_status_icon_set_has_tooltip (GtkStatusIcon *status_icon, * Returns the current value of the has-tooltip property. * See #GtkStatusIcon:has-tooltip for more information. * - * Return value: current value of has-tooltip on @status_icon. + * Returns: current value of has-tooltip on @status_icon. * * Since: 2.16 */ @@ -2493,7 +2493,7 @@ gtk_status_icon_set_tooltip_text (GtkStatusIcon *status_icon, * * Gets the contents of the tooltip for @status_icon. * - * Return value: the tooltip text, or %NULL. You should free the + * Returns: the tooltip text, or %NULL. You should free the * returned string with g_free() when done. * * Since: 2.16 @@ -2577,7 +2577,7 @@ gtk_status_icon_set_tooltip_markup (GtkStatusIcon *status_icon, * * Gets the contents of the tooltip for @status_icon. * - * Return value: the tooltip text, or %NULL. You should free the + * Returns: the tooltip text, or %NULL. You should free the * returned string with g_free() when done. * * Since: 2.16 @@ -2623,7 +2623,7 @@ gtk_status_icon_get_tooltip_markup (GtkStatusIcon *status_icon) * more likely to be met by one of the non-X11 specific methods, such * as gtk_status_icon_position_menu(). * - * Return value: An 32 bit unsigned integer identifier for the + * Returns: An 32 bit unsigned integer identifier for the * underlying X11 Window * * Since: 2.14 diff --git a/gtk/gtkswitch.c b/gtk/gtkswitch.c index ad24dcad63..354e9e514f 100644 --- a/gtk/gtkswitch.c +++ b/gtk/gtkswitch.c @@ -911,7 +911,7 @@ gtk_switch_init (GtkSwitch *self) * * Creates a new #GtkSwitch widget. * - * Return value: the newly created #GtkSwitch instance + * Returns: the newly created #GtkSwitch instance * * Since: 3.0 */ @@ -976,7 +976,7 @@ gtk_switch_set_active (GtkSwitch *sw, * * Gets whether the #GtkSwitch is in its “on” or “off” state. * - * Return value: %TRUE if the #GtkSwitch is active, and %FALSE otherwise + * Returns: %TRUE if the #GtkSwitch is active, and %FALSE otherwise * * Since: 3.0 */ diff --git a/gtk/gtktextattributes.c b/gtk/gtktextattributes.c index 363c4699ca..a5dd897eff 100644 --- a/gtk/gtktextattributes.c +++ b/gtk/gtktextattributes.c @@ -58,7 +58,7 @@ * Creates a #GtkTextAttributes, which describes * a set of properties on some text. * - * Return value: a new #GtkTextAttributes, + * Returns: a new #GtkTextAttributes, * free with gtk_text_attributes_unref(). */ GtkTextAttributes* @@ -86,7 +86,7 @@ gtk_text_attributes_new (void) * * Copies @src and returns a new #GtkTextAttributes. * - * Return value: a copy of @src, + * Returns: a copy of @src, * free with gtk_text_attributes_unref() */ GtkTextAttributes* diff --git a/gtk/gtktextbtree.c b/gtk/gtktextbtree.c index 5c9ea686f0..a7c86c5120 100644 --- a/gtk/gtktextbtree.c +++ b/gtk/gtktextbtree.c @@ -5023,7 +5023,7 @@ gtk_text_btree_node_invalidate_upward (GtkTextBTreeNode *node, gpointer view_id) * Check to see if the entire #GtkTextBTree is valid or not for * the given view. * - * Return value: %TRUE if the entire #GtkTextBTree is valid + * Returns: %TRUE if the entire #GtkTextBTree is valid **/ gboolean _gtk_text_btree_is_valid (GtkTextBTree *tree, @@ -5224,7 +5224,7 @@ gtk_text_btree_node_validate (BTreeView *view, * Validate a single contiguous invalid region of a #GtkTextBTree for * a given view. * - * Return value: %TRUE if a region has been validated, %FALSE if the + * Returns: %TRUE if a region has been validated, %FALSE if the * entire tree was already valid. **/ gboolean diff --git a/gtk/gtktextbuffer.c b/gtk/gtktextbuffer.c index 423f649186..e562c331ec 100644 --- a/gtk/gtktextbuffer.c +++ b/gtk/gtktextbuffer.c @@ -767,7 +767,7 @@ gtk_text_buffer_notify (GObject *object, * * Creates a new text buffer. * - * Return value: a new text buffer + * Returns: a new text buffer **/ GtkTextBuffer* gtk_text_buffer_new (GtkTextTagTable *table) @@ -837,7 +837,7 @@ _gtk_text_buffer_get_btree (GtkTextBuffer *buffer) * * Get the #GtkTextTagTable associated with this buffer. * - * Return value: (transfer none): the buffer’s tag table + * Returns: (transfer none): the buffer’s tag table **/ GtkTextTagTable* gtk_text_buffer_get_tag_table (GtkTextBuffer *buffer) @@ -996,7 +996,7 @@ gtk_text_buffer_insert_at_cursor (GtkTextBuffer *buffer, * have a tag affecting editability applied to it. Typically the * result of gtk_text_view_get_editable() is appropriate here. * - * Return value: whether text was actually inserted + * Returns: whether text was actually inserted **/ gboolean gtk_text_buffer_insert_interactive (GtkTextBuffer *buffer, @@ -1034,7 +1034,7 @@ gtk_text_buffer_insert_interactive (GtkTextBuffer *buffer, * have a tag affecting editability applied to it. Typically the * result of gtk_text_view_get_editable() is appropriate here. * - * Return value: whether text was actually inserted + * Returns: whether text was actually inserted **/ gboolean gtk_text_buffer_insert_interactive_at_cursor (GtkTextBuffer *buffer, @@ -1689,7 +1689,7 @@ gtk_text_buffer_delete (GtkTextBuffer *buffer, * the location of the last deleted range, or left untouched if * no text was deleted. * - * Return value: whether some text was actually deleted + * Returns: whether some text was actually deleted **/ gboolean gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer, @@ -1835,7 +1835,7 @@ gtk_text_buffer_delete_interactive (GtkTextBuffer *buffer, * and character indexes into the buffer. Contrast with * gtk_text_buffer_get_slice(). * - * Return value: an allocated UTF-8 string + * Returns: an allocated UTF-8 string **/ gchar* gtk_text_buffer_get_text (GtkTextBuffer *buffer, @@ -1873,7 +1873,7 @@ gtk_text_buffer_get_text (GtkTextBuffer *buffer, * text as well, so it is not a reliable indicator that a pixbuf or * widget is in the buffer. * - * Return value: an allocated UTF-8 string + * Returns: an allocated UTF-8 string **/ gchar* gtk_text_buffer_get_slice (GtkTextBuffer *buffer, @@ -1994,7 +1994,7 @@ gtk_text_buffer_insert_child_anchor (GtkTextBuffer *buffer, * owned by the buffer; no reference count is returned to * the caller of gtk_text_buffer_create_child_anchor(). * - * Return value: (transfer none): the created child anchor + * Returns: (transfer none): the created child anchor **/ GtkTextChildAnchor* gtk_text_buffer_create_child_anchor (GtkTextBuffer *buffer, @@ -2059,7 +2059,7 @@ gtk_text_buffer_mark_set (GtkTextBuffer *buffer, * Move the mark to the given position, if not @should_exist, * create the mark. * - * Return value: mark + * Returns: mark **/ static GtkTextMark* gtk_text_buffer_set_mark (GtkTextBuffer *buffer, @@ -2115,7 +2115,7 @@ gtk_text_buffer_set_mark (GtkTextBuffer *buffer, * Emits the #GtkTextBuffer::mark-set signal as notification of the mark's * initial placement. * - * Return value: (transfer none): the new #GtkTextMark object + * Returns: (transfer none): the new #GtkTextMark object **/ GtkTextMark* gtk_text_buffer_create_mark (GtkTextBuffer *buffer, @@ -2256,7 +2256,7 @@ gtk_text_buffer_delete_mark (GtkTextBuffer *buffer, * Returns the mark named @name in buffer @buffer, or %NULL if no such * mark exists in the buffer. * - * Return value: (transfer none): a #GtkTextMark, or %NULL + * Returns: (transfer none): a #GtkTextMark, or %NULL **/ GtkTextMark* gtk_text_buffer_get_mark (GtkTextBuffer *buffer, @@ -2339,7 +2339,7 @@ gtk_text_buffer_delete_mark_by_name (GtkTextBuffer *buffer, * named “insert”, but very slightly more efficient, and involves less * typing. * - * Return value: (transfer none): insertion point mark + * Returns: (transfer none): insertion point mark **/ GtkTextMark* gtk_text_buffer_get_insert (GtkTextBuffer *buffer) @@ -2365,7 +2365,7 @@ gtk_text_buffer_get_insert (GtkTextBuffer *buffer) * for handling the selection, if you just want to know whether there’s a * selection and what its bounds are. * - * Return value: (transfer none): selection bound mark + * Returns: (transfer none): selection bound mark **/ GtkTextMark* gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer) @@ -2478,7 +2478,7 @@ gtk_text_buffer_select_range (GtkTextBuffer *buffer, * The @first_property_name argument and subsequent arguments are a list * of properties to set on the tag, as with g_object_set(). * - * Return value: (transfer none): a new tag + * Returns: (transfer none): a new tag */ GtkTextTag* gtk_text_buffer_create_tag (GtkTextBuffer *buffer, @@ -3025,7 +3025,7 @@ gtk_text_buffer_get_bounds (GtkTextBuffer *buffer, * %FALSE. Used for example to enable a “save” function in a text * editor. * - * Return value: %TRUE if the buffer has been modified + * Returns: %TRUE if the buffer has been modified **/ gboolean gtk_text_buffer_get_modified (GtkTextBuffer *buffer) @@ -3071,7 +3071,7 @@ gtk_text_buffer_set_modified (GtkTextBuffer *buffer, * * Indicates whether the buffer has some text currently selected. * - * Return value: %TRUE if the there is text selected + * Returns: %TRUE if the there is text selected * * Since: 2.10 **/ @@ -3095,7 +3095,7 @@ gtk_text_buffer_get_has_selection (GtkTextBuffer *buffer) * Obtains the number of lines in the buffer. This value is cached, so * the function is very fast. * - * Return value: number of lines in the buffer + * Returns: number of lines in the buffer **/ gint gtk_text_buffer_get_line_count (GtkTextBuffer *buffer) @@ -3114,7 +3114,7 @@ gtk_text_buffer_get_line_count (GtkTextBuffer *buffer) * the buffer in string form to be this many bytes long. The character * count is cached, so this function is very fast. * - * Return value: number of characters in the buffer + * Returns: number of characters in the buffer **/ gint gtk_text_buffer_get_char_count (GtkTextBuffer *buffer) @@ -3825,7 +3825,7 @@ gtk_text_buffer_paste_clipboard (GtkTextBuffer *buffer, * the editability of the selection will be considered (users can’t delete * uneditable text). * - * Return value: whether there was a non-empty selection to delete + * Returns: whether there was a non-empty selection to delete **/ gboolean gtk_text_buffer_delete_selection (GtkTextBuffer *buffer, @@ -3868,7 +3868,7 @@ gtk_text_buffer_delete_selection (GtkTextBuffer *buffer, * invalid after calling this function; however, the @iter will be * re-initialized to point to the location where text was deleted. * - * Return value: %TRUE if the buffer was modified + * Returns: %TRUE if the buffer was modified * * Since: 2.6 **/ @@ -4067,7 +4067,7 @@ gtk_text_buffer_copy_clipboard (GtkTextBuffer *buffer, * NULL, then they are not filled in, but the return value still indicates * whether text is selected. * - * Return value: whether the selection has nonzero length + * Returns: whether the selection has nonzero length **/ gboolean gtk_text_buffer_get_selection_bounds (GtkTextBuffer *buffer, @@ -4203,7 +4203,7 @@ gtk_text_buffer_get_target_list (GtkTextBuffer *buffer, * using gtk_target_list_add_rich_text_targets() and * gtk_target_list_add_text_targets(). * - * Return value: (transfer none): the #GtkTargetList + * Returns: (transfer none): the #GtkTargetList * * Since: 2.10 **/ @@ -4235,7 +4235,7 @@ gtk_text_buffer_get_copy_target_list (GtkTextBuffer *buffer) * using gtk_target_list_add_rich_text_targets() and * gtk_target_list_add_text_targets(). * - * Return value: (transfer none): the #GtkTargetList + * Returns: (transfer none): the #GtkTargetList * * Since: 2.10 **/ diff --git a/gtk/gtktextbufferrichtext.c b/gtk/gtktextbufferrichtext.c index 160dd82c92..4a89b7c75a 100644 --- a/gtk/gtktextbufferrichtext.c +++ b/gtk/gtktextbufferrichtext.c @@ -64,7 +64,7 @@ static GQuark deserialize_quark (void); * This function registers a rich text serialization @function along with * its @mime_type with the passed @buffer. * - * Return value: (transfer none): the #GdkAtom that corresponds to the + * Returns: (transfer none): the #GdkAtom that corresponds to the * newly registered format’s mime-type. * * Since: 2.10 @@ -121,7 +121,7 @@ gtk_text_buffer_register_serialize_format (GtkTextBuffer *buffer, * identifier != %NULL here, since the %NULL tagset requires the * receiving buffer to deal with with pasting of arbitrary tags. * - * Return value: (transfer none): the #GdkAtom that corresponds to the + * Returns: (transfer none): the #GdkAtom that corresponds to the * newly registered format’s mime-type. * * Since: 2.10 @@ -162,7 +162,7 @@ gtk_text_buffer_register_serialize_tagset (GtkTextBuffer *buffer, * This function registers a rich text deserialization @function along with * its @mime_type with the passed @buffer. * - * Return value: (transfer none): the #GdkAtom that corresponds to the + * Returns: (transfer none): the #GdkAtom that corresponds to the * newly registered format’s mime-type. * * Since: 2.10 @@ -205,7 +205,7 @@ gtk_text_buffer_register_deserialize_format (GtkTextBuffer *buffe * format with the passed @buffer. See * gtk_text_buffer_register_serialize_tagset() for details. * - * Return value: (transfer none): the #GdkAtom that corresponds to the + * Returns: (transfer none): the #GdkAtom that corresponds to the * newly registered format’s mime-type. * * Since: 2.10 @@ -361,7 +361,7 @@ gtk_text_buffer_deserialize_set_can_create_tags (GtkTextBuffer *buffer, * This functions returns the value set with * gtk_text_buffer_deserialize_set_can_create_tags() * - * Return value: whether deserializing this format may create tags + * Returns: whether deserializing this format may create tags * * Since: 2.10 **/ @@ -406,7 +406,7 @@ gtk_text_buffer_deserialize_get_can_create_tags (GtkTextBuffer *buffer, * with @buffer using gtk_text_buffer_register_serialize_format() or * gtk_text_buffer_register_serialize_tagset() * - * Return value: (array length=n_formats) (transfer container): an array of + * Returns: (array length=n_formats) (transfer container): an array of * #GdkAtoms representing the registered formats. * * Since: 2.10 @@ -434,7 +434,7 @@ gtk_text_buffer_get_serialize_formats (GtkTextBuffer *buffer, * with @buffer using gtk_text_buffer_register_deserialize_format() or * gtk_text_buffer_register_deserialize_tagset() * - * Return value: (array length=n_formats) (transfer container): an array of + * Returns: (array length=n_formats) (transfer container): an array of * #GdkAtoms representing the registered formats. * * Since: 2.10 @@ -469,7 +469,7 @@ gtk_text_buffer_get_deserialize_formats (GtkTextBuffer *buffer, * gtk_text_buffer_register_serialize_format() or * gtk_text_buffer_register_serialize_tagset() beforehand. * - * Return value: (array length=length) (transfer full): the serialized + * Returns: (array length=length) (transfer full): the serialized * data, encoded as @format * * Since: 2.10 @@ -530,7 +530,7 @@ gtk_text_buffer_serialize (GtkTextBuffer *register_buffer, * gtk_text_buffer_register_deserialize_format() or * gtk_text_buffer_register_deserialize_tagset() beforehand. * - * Return value: %TRUE on success, %FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. * * Since: 2.10 **/ diff --git a/gtk/gtktextchild.c b/gtk/gtktextchild.c index 9fe5fdafcf..de609d49e9 100644 --- a/gtk/gtktextchild.c +++ b/gtk/gtktextchild.c @@ -333,7 +333,7 @@ gtk_text_child_anchor_class_init (GtkTextChildAnchorClass *klass) * To perform the creation and insertion in one step, use the * convenience function gtk_text_buffer_create_child_anchor(). * - * Return value: a new #GtkTextChildAnchor + * Returns: a new #GtkTextChildAnchor **/ GtkTextChildAnchor* gtk_text_child_anchor_new (void) @@ -387,7 +387,7 @@ gtk_text_child_anchor_finalize (GObject *obj) * The returned list should be freed with g_list_free(). * * - * Return value: (element-type GtkWidget) (transfer container): list of widgets anchored at @anchor + * Returns: (element-type GtkWidget) (transfer container): list of widgets anchored at @anchor **/ GList* gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor) @@ -425,7 +425,7 @@ gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor) * to use this function — otherwise all deleted child anchors * will also be finalized. * - * Return value: %TRUE if the child anchor has been deleted from its buffer + * Returns: %TRUE if the child anchor has been deleted from its buffer **/ gboolean gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor) diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c index 49bda5d89c..5b91919a61 100644 --- a/gtk/gtktextiter.c +++ b/gtk/gtktextiter.c @@ -382,7 +382,7 @@ check_invariants (const GtkTextIter *iter) * * Returns the #GtkTextBuffer this iterator is associated with. * - * Return value: (transfer none): the buffer + * Returns: (transfer none): the buffer **/ GtkTextBuffer* gtk_text_iter_get_buffer (const GtkTextIter *iter) @@ -410,7 +410,7 @@ gtk_text_iter_get_buffer (const GtkTextIter *iter) * simple assignment (`GtkTextIter i = j;`). The * function is used by language bindings. * - * Return value: a copy of the @iter, free with gtk_text_iter_free () + * Returns: a copy of the @iter, free with gtk_text_iter_free () **/ GtkTextIter* gtk_text_iter_copy (const GtkTextIter *iter) @@ -587,7 +587,7 @@ _gtk_text_iter_get_btree (const GtkTextIter *iter) * Use gtk_text_buffer_get_iter_at_offset () to convert an * offset back into an iterator. * - * Return value: a character offset + * Returns: a character offset **/ gint gtk_text_iter_get_offset (const GtkTextIter *iter) @@ -625,7 +625,7 @@ gtk_text_iter_get_offset (const GtkTextIter *iter) * a #GtkTextBuffer are numbered beginning with 0 for the first * line in the buffer. * - * Return value: a line number + * Returns: a line number **/ gint gtk_text_iter_get_line (const GtkTextIter *iter) @@ -656,7 +656,7 @@ gtk_text_iter_get_line (const GtkTextIter *iter) * counting from the start of a newline-terminated line. * The first character on the line has offset 0. * - * Return value: offset from start of line + * Returns: offset from start of line **/ gint gtk_text_iter_get_line_offset (const GtkTextIter *iter) @@ -687,7 +687,7 @@ gtk_text_iter_get_line_offset (const GtkTextIter *iter) * UTF-8, and that characters can require a variable * number of bytes to represent. * - * Return value: distance from start of line, in bytes + * Returns: distance from start of line, in bytes **/ gint gtk_text_iter_get_line_index (const GtkTextIter *iter) @@ -717,7 +717,7 @@ gtk_text_iter_get_line_index (const GtkTextIter *iter) * are invisible due to tags with the “invisible” flag * toggled on. * - * Return value: offset in visible characters from the start of the line + * Returns: offset in visible characters from the start of the line **/ gint gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter) @@ -782,7 +782,7 @@ gtk_text_iter_get_visible_line_offset (const GtkTextIter *iter) * are invisible due to tags with the “invisible” flag * toggled on. * - * Return value: byte index of @iter with respect to the start of the line + * Returns: byte index of @iter with respect to the start of the line **/ gint gtk_text_iter_get_visible_line_index (const GtkTextIter *iter) @@ -899,7 +899,7 @@ gtk_text_iter_get_char (const GtkTextIter *iter) * text as well, so it is not a reliable indicator that a pixbuf or * widget is in the buffer. * - * Return value: slice of text from the buffer + * Returns: slice of text from the buffer **/ gchar* gtk_text_iter_get_slice (const GtkTextIter *start, @@ -925,7 +925,7 @@ gtk_text_iter_get_slice (const GtkTextIter *start, * byte offsets in the buffer. If you want offsets to correspond, see * gtk_text_iter_get_slice (). * - * Return value: array of characters from the buffer + * Returns: array of characters from the buffer **/ gchar* gtk_text_iter_get_text (const GtkTextIter *start, @@ -949,7 +949,7 @@ gtk_text_iter_get_text (const GtkTextIter *start, * Invisible text is usually invisible because a #GtkTextTag with the * “invisible” attribute turned on has been applied to it. * - * Return value: slice of text from the buffer + * Returns: slice of text from the buffer **/ gchar* gtk_text_iter_get_visible_slice (const GtkTextIter *start, @@ -973,7 +973,7 @@ gtk_text_iter_get_visible_slice (const GtkTextIter *start, * Invisible text is usually invisible because a #GtkTextTag with the * “invisible” attribute turned on has been applied to it. * - * Return value: string containing visible text in the range + * Returns: string containing visible text in the range **/ gchar* gtk_text_iter_get_visible_text (const GtkTextIter *start, @@ -996,7 +996,7 @@ gtk_text_iter_get_visible_text (const GtkTextIter *start, * (with no new reference count added). Otherwise, * %NULL is returned. * - * Return value: (transfer none): the pixbuf at @iter + * Returns: (transfer none): the pixbuf at @iter **/ GdkPixbuf* gtk_text_iter_get_pixbuf (const GtkTextIter *iter) @@ -1026,7 +1026,7 @@ gtk_text_iter_get_pixbuf (const GtkTextIter *iter) * anchor is returned (with no new reference count added). Otherwise, * %NULL is returned. * - * Return value: (transfer none): the anchor at @iter + * Returns: (transfer none): the anchor at @iter **/ GtkTextChildAnchor* gtk_text_iter_get_child_anchor (const GtkTextIter *iter) @@ -1058,7 +1058,7 @@ gtk_text_iter_get_child_anchor (const GtkTextIter *iter) * can exist in the same place. The returned list is not in any * meaningful order. * - * Return value: (element-type GtkTextMark) (transfer container): list of #GtkTextMark + * Returns: (element-type GtkTextMark) (transfer container): list of #GtkTextMark **/ GSList* gtk_text_iter_get_marks (const GtkTextIter *iter) @@ -1104,7 +1104,7 @@ gtk_text_iter_get_marks (const GtkTextIter *iter) * a tag is toggled off, then some non-empty range following @iter * does not have the tag applied to it. * - * Return value: (element-type GtkTextTag) (transfer container): tags toggled at this point + * Returns: (element-type GtkTextTag) (transfer container): tags toggled at this point **/ GSList* gtk_text_iter_get_toggled_tags (const GtkTextIter *iter, @@ -1165,7 +1165,7 @@ gtk_text_iter_get_toggled_tags (const GtkTextIter *iter, * %TRUE, gtk_text_iter_has_tag() will also return %TRUE for the same * parameters. * - * Return value: whether @iter is the start of a range tagged with @tag + * Returns: whether @iter is the start of a range tagged with @tag **/ gboolean gtk_text_iter_begins_tag (const GtkTextIter *iter, @@ -1213,7 +1213,7 @@ gtk_text_iter_begins_tag (const GtkTextIter *iter, * unlike gtk_text_iter_begins_tag(), if gtk_text_iter_ends_tag() returns %TRUE, * gtk_text_iter_has_tag() will return %FALSE for the same parameters. * - * Return value: whether @iter is the end of a range tagged with @tag + * Returns: whether @iter is the end of a range tagged with @tag **/ gboolean gtk_text_iter_ends_tag (const GtkTextIter *iter, @@ -1256,7 +1256,7 @@ gtk_text_iter_ends_tag (const GtkTextIter *iter, * gtk_text_iter_ends_tag ()), i.e. it tells you whether a range with * @tag applied to it begins or ends at @iter. * - * Return value: whether @tag is toggled on or off at @iter + * Returns: whether @tag is toggled on or off at @iter **/ gboolean gtk_text_iter_toggles_tag (const GtkTextIter *iter, @@ -1297,7 +1297,7 @@ gtk_text_iter_toggles_tag (const GtkTextIter *iter, * Returns %TRUE if @iter points to a character that is part of a range tagged * with @tag. See also gtk_text_iter_begins_tag() and gtk_text_iter_ends_tag(). * - * Return value: whether @iter is tagged with @tag + * Returns: whether @iter is tagged with @tag **/ gboolean gtk_text_iter_has_tag (const GtkTextIter *iter, @@ -1337,7 +1337,7 @@ gtk_text_iter_has_tag (const GtkTextIter *iter, * list don’t have a reference added, but you have to free the list * itself. * - * Return value: (element-type GtkTextTag) (transfer container): list of #GtkTextTag + * Returns: (element-type GtkTextTag) (transfer container): list of #GtkTextTag **/ GSList* gtk_text_iter_get_tags (const GtkTextIter *iter) @@ -1392,7 +1392,7 @@ gtk_text_iter_get_tags (const GtkTextIter *iter) * editable range. Use gtk_text_iter_can_insert() to handle this * case. * - * Return value: whether @iter is inside an editable range + * Returns: whether @iter is inside an editable range **/ gboolean gtk_text_iter_editable (const GtkTextIter *iter, @@ -1428,7 +1428,7 @@ gtk_text_iter_editable (const GtkTextIter *iter, * gtk_text_buffer_insert_interactive() uses this function to decide * whether insertions are allowed at a given position. * - * Return value: whether text inserted at @iter would be editable + * Returns: whether text inserted at @iter would be editable **/ gboolean gtk_text_iter_can_insert (const GtkTextIter *iter, @@ -1465,7 +1465,7 @@ gtk_text_iter_can_insert (const GtkTextIter *iter, * language apply to @iter, the return value is identical to that of * gtk_get_default_language (). * - * Return value: language in effect at @iter + * Returns: language in effect at @iter **/ PangoLanguage * gtk_text_iter_get_language (const GtkTextIter *iter) @@ -1494,7 +1494,7 @@ gtk_text_iter_get_language (const GtkTextIter *iter) * gtk_text_iter_get_line_offset () because it doesn’t have to compute * the offset, it just has to see whether it’s 0. * - * Return value: whether @iter begins a line + * Returns: whether @iter begins a line **/ gboolean gtk_text_iter_starts_line (const GtkTextIter *iter) @@ -1534,7 +1534,7 @@ gtk_text_iter_starts_line (const GtkTextIter *iter) * considered to be at the end of a line, even though there are no * paragraph delimiter chars there. * - * Return value: whether @iter is at the end of a line + * Returns: whether @iter is at the end of a line **/ gboolean gtk_text_iter_ends_line (const GtkTextIter *iter) @@ -1591,7 +1591,7 @@ gtk_text_iter_ends_line (const GtkTextIter *iter) * the most efficient way to check whether an iterator is the end * iterator. * - * Return value: whether @iter is the end iterator + * Returns: whether @iter is the end iterator **/ gboolean gtk_text_iter_is_end (const GtkTextIter *iter) @@ -1629,7 +1629,7 @@ gtk_text_iter_is_end (const GtkTextIter *iter) * Returns %TRUE if @iter is the first iterator in the buffer, that is * if @iter has a character offset of 0. * - * Return value: whether @iter is the first in the buffer + * Returns: whether @iter is the first in the buffer **/ gboolean gtk_text_iter_is_start (const GtkTextIter *iter) @@ -1644,7 +1644,7 @@ gtk_text_iter_is_start (const GtkTextIter *iter) * Returns the number of characters in the line containing @iter, * including the paragraph delimiters. * - * Return value: number of characters in the line + * Returns: number of characters in the line **/ gint gtk_text_iter_get_chars_in_line (const GtkTextIter *iter) @@ -1696,7 +1696,7 @@ gtk_text_iter_get_chars_in_line (const GtkTextIter *iter) * Returns the number of bytes in the line containing @iter, * including the paragraph delimiters. * - * Return value: number of bytes in the line + * Returns: number of bytes in the line **/ gint gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter) @@ -1754,7 +1754,7 @@ gtk_text_iter_get_bytes_in_line (const GtkTextIter *iter) * effects of any tags present at @iter. If any tags affected @values, * the function returns %TRUE. * - * Return value: %TRUE if @values was modified + * Returns: %TRUE if @values was modified **/ gboolean gtk_text_iter_get_attributes (const GtkTextIter *iter, @@ -2214,7 +2214,7 @@ _gtk_text_iter_backward_indexable_segment (GtkTextIter *iter) * the end iterator, and gtk_text_iter_forward_char () returns %FALSE for * convenience when writing loops. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable **/ gboolean gtk_text_iter_forward_char (GtkTextIter *iter) @@ -2243,7 +2243,7 @@ gtk_text_iter_forward_char (GtkTextIter *iter) * offset 0), gtk_text_iter_backward_char () returns %FALSE for convenience when * writing loops. * - * Return value: whether movement was possible + * Returns: whether movement was possible **/ gboolean gtk_text_iter_backward_char (GtkTextIter *iter) @@ -2282,7 +2282,7 @@ gtk_text_iter_backward_char (GtkTextIter *iter) * (the last iterator in the buffer is not dereferenceable). If @count * is 0, the function does nothing and returns %FALSE. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable **/ gboolean gtk_text_iter_forward_chars (GtkTextIter *iter, gint count) @@ -2353,7 +2353,7 @@ gtk_text_iter_forward_chars (GtkTextIter *iter, gint count) * moved onto the end iterator, then %FALSE is returned. If @count is 0, * the function does nothing and returns %FALSE. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable * **/ gboolean @@ -2466,7 +2466,7 @@ gtk_text_iter_backward_chars (GtkTextIter *iter, gint count) * through the results of gtk_text_iter_get_text (), rather than * gtk_text_iter_get_slice (). * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable **/ gboolean gtk_text_iter_forward_text_chars (GtkTextIter *iter, @@ -2487,7 +2487,7 @@ gtk_text_iter_forward_text_chars (GtkTextIter *iter, * through the results of gtk_text_iter_get_text (), rather than * gtk_text_iter_get_slice (). * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable **/ gboolean gtk_text_iter_backward_text_chars (GtkTextIter *iter, @@ -2507,7 +2507,7 @@ gtk_text_iter_backward_text_chars (GtkTextIter *iter, * If after the operation, the iter is at the end of the buffer and not * dereferencable, returns %FALSE. Otherwise, returns %TRUE. * - * Return value: whether @iter can be dereferenced + * Returns: whether @iter can be dereferenced **/ gboolean gtk_text_iter_forward_line (GtkTextIter *iter) @@ -2559,7 +2559,7 @@ gtk_text_iter_forward_line (GtkTextIter *iter) * in a loop calling this function, the line number may not change on * every iteration, if your first iteration is on line 0.) * - * Return value: whether @iter moved + * Returns: whether @iter moved **/ gboolean gtk_text_iter_backward_line (GtkTextIter *iter) @@ -2636,7 +2636,7 @@ gtk_text_iter_backward_line (GtkTextIter *iter) * the function does nothing and returns %FALSE. If @count is negative, * moves backward by 0 - @count lines. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable **/ gboolean gtk_text_iter_forward_lines (GtkTextIter *iter, gint count) @@ -2687,7 +2687,7 @@ gtk_text_iter_forward_lines (GtkTextIter *iter, gint count) * the function does nothing and returns %FALSE. If @count is negative, * moves forward by 0 - @count lines. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable **/ gboolean gtk_text_iter_backward_lines (GtkTextIter *iter, gint count) @@ -2723,7 +2723,7 @@ gtk_text_iter_backward_lines (GtkTextIter *iter, gint count) * the end of the buffer and is now not dereferenceable, or if @iter was * already at the end of the buffer. * - * Return value: whether @iter can be dereferenced + * Returns: whether @iter can be dereferenced * * Since: 2.8 **/ @@ -2763,7 +2763,7 @@ gtk_text_iter_forward_visible_line (GtkTextIter *iter) * in a loop calling this function, the line number may not change on * every iteration, if your first iteration is on line 0.) * - * Return value: whether @iter moved + * Returns: whether @iter moved * * Since: 2.8 **/ @@ -2804,7 +2804,7 @@ gtk_text_iter_backward_visible_line (GtkTextIter *iter) * the function does nothing and returns %FALSE. If @count is negative, * moves backward by 0 - @count lines. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable * * Since: 2.8 **/ @@ -2844,7 +2844,7 @@ gtk_text_iter_forward_visible_lines (GtkTextIter *iter, * the function does nothing and returns %FALSE. If @count is negative, * moves forward by 0 - @count lines. * - * Return value: whether @iter moved and is dereferenceable + * Returns: whether @iter moved and is dereferenceable * * Since: 2.8 **/ @@ -3219,7 +3219,7 @@ move_multiple_steps (GtkTextIter *iter, * language (if not, the correct fix would be to the Pango word break * algorithms). * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_forward_word_end (GtkTextIter *iter) @@ -3237,7 +3237,7 @@ gtk_text_iter_forward_word_end (GtkTextIter *iter) * language (if not, the correct fix would be to the Pango word break * algorithms). * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_backward_word_start (GtkTextIter *iter) @@ -3256,7 +3256,7 @@ gtk_text_iter_backward_word_start (GtkTextIter *iter) * * Calls gtk_text_iter_forward_word_end() up to @count times. * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_forward_word_ends (GtkTextIter *iter, @@ -3274,7 +3274,7 @@ gtk_text_iter_forward_word_ends (GtkTextIter *iter, * * Calls gtk_text_iter_backward_word_start() up to @count times. * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_backward_word_starts (GtkTextIter *iter, @@ -3295,7 +3295,7 @@ gtk_text_iter_backward_word_starts (GtkTextIter *iter, * language (if not, the correct fix would be to the Pango word break * algorithms). * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator * * Since: 2.4 **/ @@ -3315,7 +3315,7 @@ gtk_text_iter_forward_visible_word_end (GtkTextIter *iter) * language (if not, the correct fix would be to the Pango word break * algorithms). * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator * * Since: 2.4 **/ @@ -3332,7 +3332,7 @@ gtk_text_iter_backward_visible_word_start (GtkTextIter *iter) * * Calls gtk_text_iter_forward_visible_word_end() up to @count times. * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator * * Since: 2.4 **/ @@ -3352,7 +3352,7 @@ gtk_text_iter_forward_visible_word_ends (GtkTextIter *iter, * * Calls gtk_text_iter_backward_visible_word_start() up to @count times. * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator * * Since: 2.4 **/ @@ -3374,7 +3374,7 @@ gtk_text_iter_backward_visible_word_starts (GtkTextIter *iter, * language (if not, the correct fix would be to the Pango word break * algorithms). * - * Return value: %TRUE if @iter is at the start of a word + * Returns: %TRUE if @iter is at the start of a word **/ gboolean gtk_text_iter_starts_word (const GtkTextIter *iter) @@ -3391,7 +3391,7 @@ gtk_text_iter_starts_word (const GtkTextIter *iter) * language (if not, the correct fix would be to the Pango word break * algorithms). * - * Return value: %TRUE if @iter is at the end of a word + * Returns: %TRUE if @iter is at the end of a word **/ gboolean gtk_text_iter_ends_word (const GtkTextIter *iter) @@ -3408,7 +3408,7 @@ gtk_text_iter_ends_word (const GtkTextIter *iter) * by Pango and should be correct for nearly any language (if not, the * correct fix would be to the Pango word break algorithms). * - * Return value: %TRUE if @iter is inside a word + * Returns: %TRUE if @iter is inside a word **/ gboolean gtk_text_iter_inside_word (const GtkTextIter *iter) @@ -3425,7 +3425,7 @@ gtk_text_iter_inside_word (const GtkTextIter *iter) * (if not, the correct fix would be to the Pango text boundary * algorithms). * - * Return value: %TRUE if @iter is at the start of a sentence. + * Returns: %TRUE if @iter is at the start of a sentence. **/ gboolean gtk_text_iter_starts_sentence (const GtkTextIter *iter) @@ -3442,7 +3442,7 @@ gtk_text_iter_starts_sentence (const GtkTextIter *iter) * (if not, the correct fix would be to the Pango text boundary * algorithms). * - * Return value: %TRUE if @iter is at the end of a sentence. + * Returns: %TRUE if @iter is at the end of a sentence. **/ gboolean gtk_text_iter_ends_sentence (const GtkTextIter *iter) @@ -3460,7 +3460,7 @@ gtk_text_iter_ends_sentence (const GtkTextIter *iter) * by Pango and should be correct for nearly any language (if not, the * correct fix would be to the Pango text boundary algorithms). * - * Return value: %TRUE if @iter is inside a sentence. + * Returns: %TRUE if @iter is inside a sentence. **/ gboolean gtk_text_iter_inside_sentence (const GtkTextIter *iter) @@ -3478,7 +3478,7 @@ gtk_text_iter_inside_sentence (const GtkTextIter *iter) * any language (if not, the correct fix would be to the Pango text * boundary algorithms). * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_forward_sentence_end (GtkTextIter *iter) @@ -3496,7 +3496,7 @@ gtk_text_iter_forward_sentence_end (GtkTextIter *iter) * any language (if not, the correct fix would be to the Pango text * boundary algorithms). * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_backward_sentence_start (GtkTextIter *iter) @@ -3516,7 +3516,7 @@ gtk_text_iter_backward_sentence_start (GtkTextIter *iter) * gtk_text_iter_forward_sentence_end() returns %FALSE). If @count is * negative, moves backward instead of forward. * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_forward_sentence_ends (GtkTextIter *iter, @@ -3536,7 +3536,7 @@ gtk_text_iter_forward_sentence_ends (GtkTextIter *iter, * or until it returns %FALSE. If @count is negative, moves forward * instead of backward. * - * Return value: %TRUE if @iter moved and is not the end iterator + * Returns: %TRUE if @iter moved and is not the end iterator **/ gboolean gtk_text_iter_backward_sentence_starts (GtkTextIter *iter, @@ -3611,7 +3611,7 @@ is_cursor_pos_func (const PangoLogAttr *attrs, * between those two characters. See also the #PangoLogAttr-struct and * pango_break() function. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable **/ gboolean gtk_text_iter_forward_cursor_position (GtkTextIter *iter) @@ -3625,7 +3625,7 @@ gtk_text_iter_forward_cursor_position (GtkTextIter *iter) * * Like gtk_text_iter_forward_cursor_position(), but moves backward. * - * Return value: %TRUE if we moved + * Returns: %TRUE if we moved **/ gboolean gtk_text_iter_backward_cursor_position (GtkTextIter *iter) @@ -3641,7 +3641,7 @@ gtk_text_iter_backward_cursor_position (GtkTextIter *iter) * Moves up to @count cursor positions. See * gtk_text_iter_forward_cursor_position() for details. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable **/ gboolean gtk_text_iter_forward_cursor_positions (GtkTextIter *iter, @@ -3660,7 +3660,7 @@ gtk_text_iter_forward_cursor_positions (GtkTextIter *iter, * Moves up to @count cursor positions. See * gtk_text_iter_forward_cursor_position() for details. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable **/ gboolean gtk_text_iter_backward_cursor_positions (GtkTextIter *iter, @@ -3678,7 +3678,7 @@ gtk_text_iter_backward_cursor_positions (GtkTextIter *iter, * Moves @iter forward to the next visible cursor position. See * gtk_text_iter_forward_cursor_position() for details. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable * * Since: 2.4 **/ @@ -3695,7 +3695,7 @@ gtk_text_iter_forward_visible_cursor_position (GtkTextIter *iter) * Moves @iter forward to the previous visible cursor position. See * gtk_text_iter_backward_cursor_position() for details. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable * * Since: 2.4 **/ @@ -3713,7 +3713,7 @@ gtk_text_iter_backward_visible_cursor_position (GtkTextIter *iter) * Moves up to @count visible cursor positions. See * gtk_text_iter_forward_cursor_position() for details. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable * * Since: 2.4 **/ @@ -3734,7 +3734,7 @@ gtk_text_iter_forward_visible_cursor_positions (GtkTextIter *iter, * Moves up to @count visible cursor positions. See * gtk_text_iter_backward_cursor_position() for details. * - * Return value: %TRUE if we moved and the new position is dereferenceable + * Returns: %TRUE if we moved and the new position is dereferenceable * * Since: 2.4 **/ @@ -3754,7 +3754,7 @@ gtk_text_iter_backward_visible_cursor_positions (GtkTextIter *iter, * See gtk_text_iter_forward_cursor_position() or #PangoLogAttr or * pango_break() for details on what a cursor position is. * - * Return value: %TRUE if the cursor can be placed at @iter + * Returns: %TRUE if the cursor can be placed at @iter **/ gboolean gtk_text_iter_is_cursor_position (const GtkTextIter *iter) @@ -4100,7 +4100,7 @@ find_paragraph_delimiter_for_line (GtkTextIter *iter) * not end in paragraph delimiters, moves to the end iterator (end of * the last line), and returns %FALSE. * - * Return value: %TRUE if we moved and the new location is not the end iterator + * Returns: %TRUE if we moved and the new location is not the end iterator **/ gboolean gtk_text_iter_forward_to_line_end (GtkTextIter *iter) @@ -4150,7 +4150,7 @@ gtk_text_iter_forward_to_line_end (GtkTextIter *iter) * the location of the toggle, or to the end of the buffer * if no toggle is found. * - * Return value: whether we found a tag toggle after @iter + * Returns: whether we found a tag toggle after @iter **/ gboolean gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter, @@ -4235,7 +4235,7 @@ gtk_text_iter_forward_to_tag_toggle (GtkTextIter *iter, * to the location of the toggle, or the start of the buffer * if no toggle is found. * - * Return value: whether we found a tag toggle before @iter + * Returns: whether we found a tag toggle before @iter **/ gboolean gtk_text_iter_backward_to_tag_toggle (GtkTextIter *iter, @@ -4347,7 +4347,7 @@ matches_pred (GtkTextIter *iter, * If @pred never returns %TRUE, @iter is set to @limit if * @limit is non-%NULL, otherwise to the end iterator. * - * Return value: whether a match was found + * Returns: whether a match was found **/ gboolean gtk_text_iter_forward_find_char (GtkTextIter *iter, @@ -4382,7 +4382,7 @@ gtk_text_iter_forward_find_char (GtkTextIter *iter, * * Same as gtk_text_iter_forward_find_char(), but goes backward from @iter. * - * Return value: whether a match was found + * Returns: whether a match was found **/ gboolean gtk_text_iter_backward_find_char (GtkTextIter *iter, @@ -5341,7 +5341,7 @@ gtk_text_iter_backward_search (const GtkTextIter *iter, * comparing the offsets yourself. Also, it’s a bit faster than * gtk_text_iter_compare(). * - * Return value: %TRUE if the iterators point to the same place in the buffer + * Returns: %TRUE if the iterators point to the same place in the buffer **/ gboolean gtk_text_iter_equal (const GtkTextIter *lhs, @@ -5381,7 +5381,7 @@ gtk_text_iter_equal (const GtkTextIter *lhs, * Ordering is in character offset order, i.e. the first character in the buffer * is less than the second character in the buffer. * - * Return value: -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal + * Returns: -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal **/ gint gtk_text_iter_compare (const GtkTextIter *lhs, @@ -5451,7 +5451,7 @@ gtk_text_iter_compare (const GtkTextIter *lhs, * Checks whether @iter falls in the range [@start, @end). * @start and @end must be in ascending order. * - * Return value: %TRUE if @iter is in the range + * Returns: %TRUE if @iter is in the range **/ gboolean gtk_text_iter_in_range (const GtkTextIter *iter, diff --git a/gtk/gtktextlayout.c b/gtk/gtktextlayout.c index 7c551c160c..4ad0aee3ae 100644 --- a/gtk/gtktextlayout.c +++ b/gtk/gtktextlayout.c @@ -477,7 +477,7 @@ gtk_text_layout_set_keyboard_direction (GtkTextLayout *layout, * Gets the text buffer used by the layout. See * gtk_text_layout_set_buffer(). * - * Return value: the text buffer used by the layout. + * Returns: the text buffer used by the layout. */ GtkTextBuffer * gtk_text_layout_get_buffer (GtkTextLayout *layout) @@ -544,7 +544,7 @@ gtk_text_layout_set_cursor_visible (GtkTextLayout *layout, * * Returns whether the insertion cursor will be shown. * - * Return value: if %FALSE, the insertion cursor will not be + * Returns: if %FALSE, the insertion cursor will not be * shown, even if the text is editable. */ gboolean @@ -707,7 +707,7 @@ gtk_text_layout_wrap (GtkTextLayout *layout, /** * gtk_text_layout_get_lines: * - * Return value: (element-type GtkTextLine) (transfer container): + * Returns: (element-type GtkTextLine) (transfer container): */ GSList* gtk_text_layout_get_lines (GtkTextLayout *layout, @@ -973,7 +973,7 @@ gtk_text_layout_real_free_line_data (GtkTextLayout *layout, * * Check if there are any invalid regions in a #GtkTextLayout’s buffer * - * Return value: %TRUE if any invalid regions were found + * Returns: %TRUE if any invalid regions were found */ gboolean gtk_text_layout_is_valid (GtkTextLayout *layout) @@ -1467,7 +1467,7 @@ gtk_text_attr_appearance_compare (const PangoAttribute *attr1, * allows setting family, style, weight, variant, stretch, * and size simultaneously.) * - * Return value: + * Returns: */ static PangoAttribute * gtk_text_attr_appearance_new (const GtkTextAppearance *appearance) diff --git a/gtk/gtktextmark.c b/gtk/gtktextmark.c index d0fddd3bf9..7a1b7e3334 100644 --- a/gtk/gtktextmark.c +++ b/gtk/gtktextmark.c @@ -238,7 +238,7 @@ gtk_text_mark_get_property (GObject *object, * mark with right gravity (when you type, the cursor stays on the right * side of the text you’re typing). * - * Return value: new #GtkTextMark + * Returns: new #GtkTextMark * * Since: 2.12 **/ @@ -259,7 +259,7 @@ gtk_text_mark_new (const gchar *name, * Returns %TRUE if the mark is visible (i.e. a cursor is displayed * for it). * - * Return value: %TRUE if visible + * Returns: %TRUE if visible **/ gboolean gtk_text_mark_get_visible (GtkTextMark *mark) @@ -277,7 +277,7 @@ gtk_text_mark_get_visible (GtkTextMark *mark) * * Returns the mark name; returns NULL for anonymous marks. * - * Return value: mark name + * Returns: mark name **/ const char * gtk_text_mark_get_name (GtkTextMark *mark) @@ -297,7 +297,7 @@ gtk_text_mark_get_name (GtkTextMark *mark) * with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark() * for a way to add it to a buffer again. * - * Return value: whether the mark is deleted + * Returns: whether the mark is deleted **/ gboolean gtk_text_mark_get_deleted (GtkTextMark *mark) @@ -321,7 +321,7 @@ gtk_text_mark_get_deleted (GtkTextMark *mark) * Gets the buffer this mark is located inside, * or %NULL if the mark is deleted. * - * Return value: (transfer none): the mark’s #GtkTextBuffer + * Returns: (transfer none): the mark’s #GtkTextBuffer **/ GtkTextBuffer* gtk_text_mark_get_buffer (GtkTextMark *mark) @@ -344,7 +344,7 @@ gtk_text_mark_get_buffer (GtkTextMark *mark) * * Determines whether the mark has left gravity. * - * Return value: %TRUE if the mark has left gravity, %FALSE otherwise + * Returns: %TRUE if the mark has left gravity, %FALSE otherwise **/ gboolean gtk_text_mark_get_left_gravity (GtkTextMark *mark) diff --git a/gtk/gtktexttag.c b/gtk/gtktexttag.c index e9ee74a856..4510872c51 100644 --- a/gtk/gtktexttag.c +++ b/gtk/gtktexttag.c @@ -767,7 +767,7 @@ gtk_text_tag_init (GtkTextTag *text_tag) * Creates a #GtkTextTag. Configure the tag using object arguments, * i.e. using g_object_set(). * - * Return value: a new #GtkTextTag + * Returns: a new #GtkTextTag **/ GtkTextTag* gtk_text_tag_new (const gchar *name) @@ -1894,7 +1894,7 @@ delta_priority_foreach (GtkTextTag *tag, gpointer user_data) * * Get the tag priority. * - * Return value: The tag’s priority. + * Returns: The tag’s priority. **/ gint gtk_text_tag_get_priority (GtkTextTag *tag) @@ -1968,7 +1968,7 @@ gtk_text_tag_set_priority (GtkTextTag *tag, * * Emits the “event” signal on the #GtkTextTag. * - * Return value: result of signal emission (whether the event was handled) + * Returns: result of signal emission (whether the event was handled) **/ gboolean gtk_text_tag_event (GtkTextTag *tag, diff --git a/gtk/gtktexttagtable.c b/gtk/gtktexttagtable.c index b69df05688..f750318ab7 100644 --- a/gtk/gtktexttagtable.c +++ b/gtk/gtktexttagtable.c @@ -163,7 +163,7 @@ gtk_text_tag_table_init (GtkTextTagTable *table) * Creates a new #GtkTextTagTable. The table contains no tags by * default. * - * Return value: a new #GtkTextTagTable + * Returns: a new #GtkTextTagTable **/ GtkTextTagTable* gtk_text_tag_table_new (void) @@ -286,7 +286,7 @@ gtk_text_tag_table_add (GtkTextTagTable *table, * * Look up a named tag. * - * Return value: (transfer none): The tag, or %NULL if none by that name is in the table. + * Returns: (transfer none): The tag, or %NULL if none by that name is in the table. **/ GtkTextTag* gtk_text_tag_table_lookup (GtkTextTagTable *table, @@ -414,7 +414,7 @@ gtk_text_tag_table_foreach (GtkTextTagTable *table, * * Returns the size of the table (number of tags) * - * Return value: number of tags in @table + * Returns: number of tags in @table **/ gint gtk_text_tag_table_get_size (GtkTextTagTable *table) diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c index ee3b9b8ea6..b3c3bd15f5 100644 --- a/gtk/gtktextview.c +++ b/gtk/gtktextview.c @@ -1567,7 +1567,7 @@ gtk_text_view_init (GtkTextView *text_view) * for you. Get the buffer with gtk_text_view_get_buffer(). If you want * to specify your own buffer, consider gtk_text_view_new_with_buffer(). * - * Return value: a new #GtkTextView + * Returns: a new #GtkTextView **/ GtkWidget* gtk_text_view_new (void) @@ -1586,7 +1586,7 @@ gtk_text_view_new (void) * text view adds its own reference count to the buffer; it does not * take over an existing reference. * - * Return value: a new #GtkTextView. + * Returns: a new #GtkTextView. **/ GtkWidget* gtk_text_view_new_with_buffer (GtkTextBuffer *buffer) @@ -1768,7 +1768,7 @@ get_buffer (GtkTextView *text_view) * The reference count on the buffer is not incremented; the caller * of this function won’t own a new reference. * - * Return value: (transfer none): a #GtkTextBuffer + * Returns: (transfer none): a #GtkTextBuffer **/ GtkTextBuffer* gtk_text_view_get_buffer (GtkTextView *text_view) @@ -2007,7 +2007,7 @@ gtk_text_view_get_line_at_y (GtkTextView *text_view, * using gtk_text_view_scroll_to_mark() which saves a point to be * scrolled to after line validation. * - * Return value: %TRUE if scrolling occurred + * Returns: %TRUE if scrolling occurred **/ gboolean gtk_text_view_scroll_to_iter (GtkTextView *text_view, @@ -2481,7 +2481,7 @@ clamp_iter_onscreen (GtkTextView *text_view, GtkTextIter *iter) * Moves a mark within the buffer so that it's * located within the currently-visible text area. * - * Return value: %TRUE if the mark moved (wasn’t already onscreen) + * Returns: %TRUE if the mark moved (wasn’t already onscreen) **/ gboolean gtk_text_view_move_mark_onscreen (GtkTextView *text_view, @@ -2574,7 +2574,7 @@ gtk_text_view_set_wrap_mode (GtkTextView *text_view, * * Gets the line wrapping for the view. * - * Return value: the line wrap setting + * Returns: the line wrap setting **/ GtkWrapMode gtk_text_view_get_wrap_mode (GtkTextView *text_view) @@ -2637,7 +2637,7 @@ gtk_text_view_set_editable (GtkTextView *text_view, * Returns the default editability of the #GtkTextView. Tags in the * buffer may override this setting for some ranges of text. * - * Return value: whether text is editable by default + * Returns: whether text is editable by default **/ gboolean gtk_text_view_get_editable (GtkTextView *text_view) @@ -2685,7 +2685,7 @@ gtk_text_view_set_pixels_above_lines (GtkTextView *text_view, * * Gets the default number of pixels to put above paragraphs. * - * Return value: default number of pixels above paragraphs + * Returns: default number of pixels above paragraphs **/ gint gtk_text_view_get_pixels_above_lines (GtkTextView *text_view) @@ -2734,7 +2734,7 @@ gtk_text_view_set_pixels_below_lines (GtkTextView *text_view, * * Gets the value set by gtk_text_view_set_pixels_below_lines(). * - * Return value: default number of blank pixels below paragraphs + * Returns: default number of blank pixels below paragraphs **/ gint gtk_text_view_get_pixels_below_lines (GtkTextView *text_view) @@ -2783,7 +2783,7 @@ gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view, * * Gets the value set by gtk_text_view_set_pixels_inside_wrap(). * - * Return value: default number of pixels of blank space between wrapped lines + * Returns: default number of pixels of blank space between wrapped lines **/ gint gtk_text_view_get_pixels_inside_wrap (GtkTextView *text_view) @@ -2833,7 +2833,7 @@ gtk_text_view_set_justification (GtkTextView *text_view, * Gets the default justification of paragraphs in @text_view. * Tags in the buffer may override the default. * - * Return value: default justification + * Returns: default justification **/ GtkJustification gtk_text_view_get_justification (GtkTextView *text_view) @@ -2882,7 +2882,7 @@ gtk_text_view_set_left_margin (GtkTextView *text_view, * Gets the default left margin size of paragraphs in the @text_view. * Tags in the buffer may override the default. * - * Return value: left margin in pixels + * Returns: left margin in pixels **/ gint gtk_text_view_get_left_margin (GtkTextView *text_view) @@ -2929,7 +2929,7 @@ gtk_text_view_set_right_margin (GtkTextView *text_view, * Gets the default right margin for text in @text_view. Tags * in the buffer may override the default. * - * Return value: right margin in pixels + * Returns: right margin in pixels **/ gint gtk_text_view_get_right_margin (GtkTextView *text_view) @@ -2979,7 +2979,7 @@ gtk_text_view_set_indent (GtkTextView *text_view, * Tags in the view’s buffer may override the default. * The indentation may be negative. * - * Return value: number of pixels of indentation + * Returns: number of pixels of indentation **/ gint gtk_text_view_get_indent (GtkTextView *text_view) @@ -3036,7 +3036,7 @@ gtk_text_view_set_tabs (GtkTextView *text_view, * “standard” (8-space) tabs are used. Free the return value * with pango_tab_array_free(). * - * Return value: copy of default tab array, or %NULL if “standard” + * Returns: copy of default tab array, or %NULL if “standard” * tabs are used; must be freed with pango_tab_array_free(). **/ PangoTabArray* @@ -3096,7 +3096,7 @@ gtk_text_view_set_cursor_visible (GtkTextView *text_view, * * Find out whether the cursor is being displayed. * - * Return value: whether the insertion mark is visible + * Returns: whether the insertion mark is visible **/ gboolean gtk_text_view_get_cursor_visible (GtkTextView *text_view) @@ -3114,7 +3114,7 @@ gtk_text_view_get_cursor_visible (GtkTextView *text_view) * Moves the cursor to the currently visible region of the * buffer, it it isn’t there already. * - * Return value: %TRUE if the cursor had to be moved. + * Returns: %TRUE if the cursor had to be moved. **/ gboolean gtk_text_view_place_cursor_onscreen (GtkTextView *text_view) @@ -6601,7 +6601,7 @@ gtk_text_view_toggle_overwrite (GtkTextView *text_view) * * Returns whether the #GtkTextView is in overwrite mode or not. * - * Return value: whether @text_view is in overwrite mode or not. + * Returns: whether @text_view is in overwrite mode or not. * * Since: 2.4 **/ @@ -6670,7 +6670,7 @@ gtk_text_view_set_accepts_tab (GtkTextView *text_view, * Returns whether pressing the Tab key inserts a tab characters. * gtk_text_view_set_accepts_tab(). * - * Return value: %TRUE if pressing the Tab key inserts a tab character, + * Returns: %TRUE if pressing the Tab key inserts a tab character, * %FALSE if pressing the Tab key moves the keyboard focus. * * Since: 2.4 @@ -7293,7 +7293,7 @@ gtk_text_view_ensure_layout (GtkTextView *text_view) * The return value is a copy owned by the caller of this function, * and should be freed. * - * Return value: a new #GtkTextAttributes + * Returns: a new #GtkTextAttributes **/ GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView *text_view) @@ -7401,7 +7401,7 @@ gtk_text_view_reset_im_context (GtkTextView *text_view) * } * ]| * - * Return value: %TRUE if the input method handled the key event. + * Returns: %TRUE if the input method handled the key event. * * Since: 2.22 */ @@ -9438,7 +9438,7 @@ text_window_get_height (GtkTextWindow *win) * height is 0, and are nonexistent before the widget has been * realized. * - * Return value: (transfer none): a #GdkWindow, or %NULL + * Returns: (transfer none): a #GdkWindow, or %NULL **/ GdkWindow* gtk_text_view_get_window (GtkTextView *text_view, @@ -9506,7 +9506,7 @@ gtk_text_view_get_window (GtkTextView *text_view, * should be called on `event->window` to * see which window it was. * - * Return value: the window type. + * Returns: the window type. **/ GtkTextWindowType gtk_text_view_get_window_type (GtkTextView *text_view, @@ -9955,7 +9955,7 @@ gtk_text_view_set_border_window_size (GtkTextView *text_view, * Gets the width of the specified border window. See * gtk_text_view_set_border_window_size(). * - * Return value: width of window + * Returns: width of window **/ gint gtk_text_view_get_border_window_size (GtkTextView *text_view, @@ -10230,7 +10230,7 @@ gtk_text_view_move_child (GtkTextView *text_view, * they depend on the view’s width; paragraphs are the same in all * views, since they depend on the contents of the #GtkTextBuffer. * - * Return value: %TRUE if @iter was moved and is not on the end iterator + * Returns: %TRUE if @iter was moved and is not on the end iterator **/ gboolean gtk_text_view_forward_display_line (GtkTextView *text_view, @@ -10258,7 +10258,7 @@ gtk_text_view_forward_display_line (GtkTextView *text_view, * they depend on the view’s width; paragraphs are the same in all * views, since they depend on the contents of the #GtkTextBuffer. * - * Return value: %TRUE if @iter was moved and is not on the end iterator + * Returns: %TRUE if @iter was moved and is not on the end iterator **/ gboolean gtk_text_view_backward_display_line (GtkTextView *text_view, @@ -10286,7 +10286,7 @@ gtk_text_view_backward_display_line (GtkTextView *text_view, * they depend on the view’s width; paragraphs are the same in all * views, since they depend on the contents of the #GtkTextBuffer. * - * Return value: %TRUE if @iter was moved and is not on the end iterator + * Returns: %TRUE if @iter was moved and is not on the end iterator **/ gboolean gtk_text_view_forward_display_line_end (GtkTextView *text_view, @@ -10314,7 +10314,7 @@ gtk_text_view_forward_display_line_end (GtkTextView *text_view, * they depend on the view’s width; paragraphs are the same in all * views, since they depend on the contents of the #GtkTextBuffer. * - * Return value: %TRUE if @iter was moved and is not on the end iterator + * Returns: %TRUE if @iter was moved and is not on the end iterator **/ gboolean gtk_text_view_backward_display_line_start (GtkTextView *text_view, @@ -10337,7 +10337,7 @@ gtk_text_view_backward_display_line_start (GtkTextView *text_view, * See gtk_text_view_forward_display_line() for an explanation of * display lines vs. paragraphs. * - * Return value: %TRUE if @iter begins a wrapped line + * Returns: %TRUE if @iter begins a wrapped line **/ gboolean gtk_text_view_starts_display_line (GtkTextView *text_view, @@ -10370,7 +10370,7 @@ gtk_text_view_starts_display_line (GtkTextView *text_view, * of the current run, and there may be jumps when the cursor * is moved off of the end of a run. * - * Return value: %TRUE if @iter moved and is not on the end iterator + * Returns: %TRUE if @iter moved and is not on the end iterator **/ gboolean gtk_text_view_move_visually (GtkTextView *text_view, diff --git a/gtk/gtktogglebutton.c b/gtk/gtktogglebutton.c index e31406af70..5080097ce9 100644 --- a/gtk/gtktogglebutton.c +++ b/gtk/gtktogglebutton.c @@ -444,7 +444,7 @@ gtk_toggle_button_set_mode (GtkToggleButton *toggle_button, * Retrieves whether the button is displayed as a separate indicator * and label. See gtk_toggle_button_set_mode(). * - * Return value: %TRUE if the togglebutton is drawn as a separate indicator + * Returns: %TRUE if the togglebutton is drawn as a separate indicator * and label. **/ gboolean @@ -565,7 +565,7 @@ gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button, * * Gets the value set by gtk_toggle_button_set_inconsistent(). * - * Return value: %TRUE if the button is displayed as inconsistent, %FALSE otherwise + * Returns: %TRUE if the button is displayed as inconsistent, %FALSE otherwise **/ gboolean gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button) diff --git a/gtk/gtktoggletoolbutton.c b/gtk/gtktoggletoolbutton.c index bca04889e7..f7391143ea 100644 --- a/gtk/gtktoggletoolbutton.c +++ b/gtk/gtktoggletoolbutton.c @@ -387,7 +387,7 @@ gtk_toggle_tool_button_sync_action_properties (GtkActivatable *activatable, * * Returns a new #GtkToggleToolButton * - * Return value: a newly created #GtkToggleToolButton + * Returns: a newly created #GtkToggleToolButton * * Since: 2.4 **/ @@ -412,7 +412,7 @@ gtk_toggle_tool_button_new (void) * * It is an error if @stock_id is not a name of a stock item. * - * Return value: A new #GtkToggleToolButton + * Returns: A new #GtkToggleToolButton * * Since: 2.4 * @@ -462,7 +462,7 @@ gtk_toggle_tool_button_set_active (GtkToggleToolButton *button, * Queries a #GtkToggleToolButton and returns its current state. * Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised. * - * Return value: %TRUE if the toggle tool button is pressed in, %FALSE if not + * Returns: %TRUE if the toggle tool button is pressed in, %FALSE if not * * Since: 2.4 **/ diff --git a/gtk/gtktoolbar.c b/gtk/gtktoolbar.c index e71ab7f279..c4e55819a1 100644 --- a/gtk/gtktoolbar.c +++ b/gtk/gtktoolbar.c @@ -458,7 +458,7 @@ gtk_toolbar_class_init (GtkToolbarClass *klass) * number is given by the @button parameter. If the menu was popped * up using the keybaord, @button is -1. * - * Return value: return %TRUE if the signal was handled, %FALSE if not + * Returns: return %TRUE if the signal was handled, %FALSE if not */ toolbar_signals[POPUP_CONTEXT_MENU] = g_signal_new (I_("popup-context-menu"), @@ -479,7 +479,7 @@ gtk_toolbar_class_init (GtkToolbarClass *klass) * A keybinding signal used internally by GTK+. This signal can't * be used in application code * - * Return value: %TRUE if the signal was handled, %FALSE if not + * Returns: %TRUE if the signal was handled, %FALSE if not */ toolbar_signals[FOCUS_HOME_OR_END] = g_signal_new_class_handler (I_("focus-home-or-end"), @@ -2714,7 +2714,7 @@ gtk_toolbar_popup_menu (GtkWidget *toolbar) * * Creates a new toolbar. - * Return Value: the newly-created toolbar. + * Returns: the newly-created toolbar. **/ GtkWidget * gtk_toolbar_new (void) @@ -2760,7 +2760,7 @@ gtk_toolbar_insert (GtkToolbar *toolbar, * Returns the position of @item on the toolbar, starting from 0. * It is an error if @item is not a child of the toolbar. * - * Return value: the position of item on the toolbar. + * Returns: the position of item on the toolbar. * * Since: 2.4 **/ @@ -2823,7 +2823,7 @@ gtk_toolbar_set_style (GtkToolbar *toolbar, * Retrieves whether the toolbar has text, icons, or both . See * gtk_toolbar_set_style(). - * Return value: the current style of @toolbar + * Returns: the current style of @toolbar **/ GtkToolbarStyle gtk_toolbar_get_style (GtkToolbar *toolbar) @@ -2867,7 +2867,7 @@ gtk_toolbar_unset_style (GtkToolbar *toolbar) * * Returns the number of items on the toolbar. * - * Return value: the number of items on the toolbar + * Returns: the number of items on the toolbar * * Since: 2.4 **/ @@ -2891,7 +2891,7 @@ gtk_toolbar_get_n_items (GtkToolbar *toolbar) * Returns the @n'th item on @toolbar, or %NULL if the * toolbar does not contain an @n'th item. * - * Return value: (transfer none): The @n'th #GtkToolItem on @toolbar, + * Returns: (transfer none): The @n'th #GtkToolItem on @toolbar, * or %NULL if there isn’t an @n'th item. * * Since: 2.4 @@ -2927,7 +2927,7 @@ gtk_toolbar_get_nth_item (GtkToolbar *toolbar, * * Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size(). * - * Return value: the current icon size for the icons on the toolbar. + * Returns: the current icon size for the icons on the toolbar. **/ GtkIconSize gtk_toolbar_get_icon_size (GtkToolbar *toolbar) @@ -2944,7 +2944,7 @@ gtk_toolbar_get_icon_size (GtkToolbar *toolbar) * Returns the relief style of buttons on @toolbar. See * gtk_button_set_relief(). * - * Return value: The relief style of buttons on @toolbar. + * Returns: The relief style of buttons on @toolbar. * * Since: 2.4 **/ @@ -2999,7 +2999,7 @@ gtk_toolbar_set_show_arrow (GtkToolbar *toolbar, * Returns whether the toolbar has an overflow menu. * See gtk_toolbar_set_show_arrow(). * - * Return value: %TRUE if the toolbar has an overflow menu. + * Returns: %TRUE if the toolbar has an overflow menu. * * Since: 2.4 **/ @@ -3024,7 +3024,7 @@ gtk_toolbar_get_show_arrow (GtkToolbar *toolbar) * * @x and @y are in @toolbar coordinates. * - * Return value: The position corresponding to the point (@x, @y) on the toolbar. + * Returns: The position corresponding to the point (@x, @y) on the toolbar. * * Since: 2.4 **/ diff --git a/gtk/gtktoolbutton.c b/gtk/gtktoolbutton.c index 0b5046f655..e5ac79272b 100644 --- a/gtk/gtktoolbutton.c +++ b/gtk/gtktoolbutton.c @@ -1081,7 +1081,7 @@ gtk_tool_button_sync_action_properties (GtkActivatable *activatable, * * It is an error if @stock_id is not a name of a stock item. * - * Return value: A new #GtkToolButton + * Returns: A new #GtkToolButton * * Since: 2.4 * @@ -1109,7 +1109,7 @@ gtk_tool_button_new_from_stock (const gchar *stock_id) * Creates a new %GtkToolButton using @icon_widget as contents and @label as * label. * - * Return value: A new #GtkToolButton + * Returns: A new #GtkToolButton * * Since: 2.4 **/ @@ -1178,7 +1178,7 @@ gtk_tool_button_set_label (GtkToolButton *button, * doesn’t have a label. or uses a the label from a stock item. The returned * string is owned by GTK+, and must not be modified or freed. * - * Return value: The label, or %NULL + * Returns: The label, or %NULL * * Since: 2.4 **/ @@ -1230,7 +1230,7 @@ gtk_tool_button_set_use_underline (GtkToolButton *button, * Returns whether underscores in the label property are used as mnemonics * on menu items on the overflow menu. See gtk_tool_button_set_use_underline(). * - * Return value: %TRUE if underscores in the label property are used as + * Returns: %TRUE if underscores in the label property are used as * mnemonics on menu items on the overflow menu. * * Since: 2.4 @@ -1281,7 +1281,7 @@ gtk_tool_button_set_stock_id (GtkToolButton *button, * Returns the name of the stock item. See gtk_tool_button_set_stock_id(). * The returned string is owned by GTK+ and must not be freed or modifed. * - * Return value: the name of the stock item for @button. + * Returns: the name of the stock item for @button. * * Since: 2.4 * @@ -1439,7 +1439,7 @@ gtk_tool_button_set_label_widget (GtkToolButton *button, * Returns the widget used as label on @button. * See gtk_tool_button_set_label_widget(). * - * Return value: (transfer none): The widget used as label + * Returns: (transfer none): The widget used as label * on @button, or %NULL. * * Since: 2.4 @@ -1459,7 +1459,7 @@ gtk_tool_button_get_label_widget (GtkToolButton *button) * Return the widget used as icon widget on @button. * See gtk_tool_button_set_icon_widget(). * - * Return value: (transfer none): The widget used as icon + * Returns: (transfer none): The widget used as icon * on @button, or %NULL. * * Since: 2.4 diff --git a/gtk/gtktoolitem.c b/gtk/gtktoolitem.c index f3b2841183..4664bf8138 100644 --- a/gtk/gtktoolitem.c +++ b/gtk/gtktoolitem.c @@ -223,7 +223,7 @@ gtk_tool_item_class_init (GtkToolItemClass *klass) * to invalidate the cache and ensure that the toolbar rebuilds its overflow * menu. * - * Return value: %TRUE if the signal was handled, %FALSE if not + * Returns: %TRUE if the signal was handled, %FALSE if not **/ toolitem_signals[CREATE_MENU_PROXY] = g_signal_new (I_("create-menu-proxy"), @@ -671,7 +671,7 @@ gtk_tool_item_set_use_action_appearance (GtkToolItem *item, * * Creates a new #GtkToolItem * - * Return value: the new #GtkToolItem + * Returns: the new #GtkToolItem * * Since: 2.4 **/ @@ -693,7 +693,7 @@ gtk_tool_item_new (void) * #GtkToolItem should call this function to find out how text should * be ellipsized. * - * Return value: a #PangoEllipsizeMode indicating how text in @tool_item + * Returns: a #PangoEllipsizeMode indicating how text in @tool_item * should be ellipsized. * * Since: 2.20 @@ -720,7 +720,7 @@ gtk_tool_item_get_ellipsize_mode (GtkToolItem *tool_item) * #GtkToolItem should call this function to find out what size icons * they should use. * - * Return value: (type int): a #GtkIconSize indicating the icon size + * Returns: (type int): a #GtkIconSize indicating the icon size * used for @tool_item * * Since: 2.4 @@ -747,7 +747,7 @@ gtk_tool_item_get_icon_size (GtkToolItem *tool_item) * #GtkToolItem should call this function to find out what size icons * they should use. * - * Return value: a #GtkOrientation indicating the orientation + * Returns: a #GtkOrientation indicating the orientation * used for @tool_item * * Since: 2.4 @@ -783,7 +783,7 @@ gtk_tool_item_get_orientation (GtkToolItem *tool_item) * - %GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show * both an icon and a label, arranged horizontally * - * Return value: A #GtkToolbarStyle indicating the toolbar style used + * Returns: A #GtkToolbarStyle indicating the toolbar style used * for @tool_item. * * Since: 2.4 @@ -811,7 +811,7 @@ gtk_tool_item_get_toolbar_style (GtkToolItem *tool_item) * of the #GtkToolItem::toolbar_reconfigured signal to find out the * relief style of buttons. * - * Return value: a #GtkReliefStyle indicating the relief style used + * Returns: a #GtkReliefStyle indicating the relief style used * for @tool_item. * * Since: 2.4 @@ -838,7 +838,7 @@ gtk_tool_item_get_relief_style (GtkToolItem *tool_item) * #GtkToolItem should call this function to find out how text should * be aligned. * - * Return value: a #gfloat indicating the horizontal text alignment + * Returns: a #gfloat indicating the horizontal text alignment * used for @tool_item * * Since: 2.20 @@ -865,7 +865,7 @@ gtk_tool_item_get_text_alignment (GtkToolItem *tool_item) * #GtkToolItem should call this function to find out how text should * be orientated. * - * Return value: a #GtkOrientation indicating the text orientation + * Returns: a #GtkOrientation indicating the text orientation * used for @tool_item * * Since: 2.20 @@ -892,7 +892,7 @@ gtk_tool_item_get_text_orientation (GtkToolItem *tool_item) * Custom subclasses of #GtkToolItem should call this function * and use the size group for labels. * - * Return value: (transfer none): a #GtkSizeGroup + * Returns: (transfer none): a #GtkSizeGroup * * Since: 2.20 */ @@ -945,7 +945,7 @@ gtk_tool_item_set_expand (GtkToolItem *tool_item, * Returns whether @tool_item is allocated extra space. * See gtk_tool_item_set_expand(). * - * Return value: %TRUE if @tool_item is allocated extra space. + * Returns: %TRUE if @tool_item is allocated extra space. * * Since: 2.4 **/ @@ -991,7 +991,7 @@ gtk_tool_item_set_homogeneous (GtkToolItem *tool_item, * Returns whether @tool_item is the same size as other homogeneous * items. See gtk_tool_item_set_homogeneous(). * - * Return value: %TRUE if the item is the same size as other homogeneous + * Returns: %TRUE if the item is the same size as other homogeneous * items. * * Since: 2.4 @@ -1011,7 +1011,7 @@ gtk_tool_item_get_homogeneous (GtkToolItem *tool_item) * Returns whether @tool_item is considered important. See * gtk_tool_item_set_is_important() * - * Return value: %TRUE if @tool_item is considered important. + * Returns: %TRUE if @tool_item is considered important. * * Since: 2.4 **/ @@ -1147,7 +1147,7 @@ gtk_tool_item_set_use_drag_window (GtkToolItem *toolitem, * Returns whether @tool_item has a drag window. See * gtk_tool_item_set_use_drag_window(). * - * Return value: %TRUE if @tool_item uses a drag window. + * Returns: %TRUE if @tool_item uses a drag window. * * Since: 2.4 **/ @@ -1193,7 +1193,7 @@ gtk_tool_item_set_visible_horizontal (GtkToolItem *toolitem, * Returns whether the @tool_item is visible on toolbars that are * docked horizontally. * - * Return value: %TRUE if @tool_item is visible on toolbars that are + * Returns: %TRUE if @tool_item is visible on toolbars that are * docked horizontally. * * Since: 2.4 @@ -1244,7 +1244,7 @@ gtk_tool_item_set_visible_vertical (GtkToolItem *toolitem, * Returns whether @tool_item is visible when the toolbar is docked vertically. * See gtk_tool_item_set_visible_vertical(). * - * Return value: Whether @tool_item is visible when the toolbar is docked vertically + * Returns: Whether @tool_item is visible when the toolbar is docked vertically * * Since: 2.4 **/ @@ -1264,7 +1264,7 @@ gtk_tool_item_get_visible_vertical (GtkToolItem *toolitem) * gtk_tool_item_set_proxy_menu_item(), ie. the #GtkMenuItem * that is going to appear in the overflow menu. * - * Return value: (transfer none): The #GtkMenuItem that is going to appear in the + * Returns: (transfer none): The #GtkMenuItem that is going to appear in the * overflow menu for @tool_item. * * Since: 2.4 @@ -1295,7 +1295,7 @@ gtk_tool_item_retrieve_proxy_menu_item (GtkToolItem *tool_item) * @menu_item_ids must match ensures that a #GtkToolItem * will not inadvertently change a menu item that they did not create. * - * Return value: (transfer none): The #GtkMenuItem passed to + * Returns: (transfer none): The #GtkMenuItem passed to * gtk_tool_item_set_proxy_menu_item(), if the @menu_item_ids * match. * diff --git a/gtk/gtktoolshell.c b/gtk/gtktoolshell.c index 7ebf18c648..bd63eddebb 100644 --- a/gtk/gtktoolshell.c +++ b/gtk/gtktoolshell.c @@ -90,7 +90,7 @@ gtk_tool_shell_real_get_ellipsize_mode (GtkToolShell *shell) * Retrieves the icon size for the tool shell. Tool items must not call this * function directly, but rely on gtk_tool_item_get_icon_size() instead. * - * Return value: (type int): the current size for icons of @shell + * Returns: (type int): the current size for icons of @shell * * Since: 2.14 **/ @@ -108,7 +108,7 @@ gtk_tool_shell_get_icon_size (GtkToolShell *shell) * call this function directly, but rely on gtk_tool_item_get_orientation() * instead. * - * Return value: the current orientation of @shell + * Returns: the current orientation of @shell * * Since: 2.14 **/ @@ -126,7 +126,7 @@ gtk_tool_shell_get_orientation (GtkToolShell *shell) * not call this function directly, but rely on gtk_tool_item_get_toolbar_style() * instead. * - * Return value: the current style of @shell + * Returns: the current style of @shell * * Since: 2.14 **/ @@ -143,7 +143,7 @@ gtk_tool_shell_get_style (GtkToolShell *shell) * Returns the relief style of buttons on @shell. Tool items must not call this * function directly, but rely on gtk_tool_item_get_relief_style() instead. * - * Return value: The relief style of buttons on @shell. + * Returns: The relief style of buttons on @shell. * * Since: 2.14 **/ @@ -185,7 +185,7 @@ gtk_tool_shell_rebuild_menu (GtkToolShell *shell) * call this function directly, but rely on gtk_tool_item_get_text_orientation() * instead. * - * Return value: the current text orientation of @shell + * Returns: the current text orientation of @shell * * Since: 2.20 **/ @@ -205,7 +205,7 @@ gtk_tool_shell_get_text_orientation (GtkToolShell *shell) * call this function directly, but rely on gtk_tool_item_get_text_alignment() * instead. * - * Return value: the current text alignment of @shell + * Returns: the current text alignment of @shell * * Since: 2.20 **/ @@ -225,7 +225,7 @@ gtk_tool_shell_get_text_alignment (GtkToolShell *shell) * call this function directly, but rely on gtk_tool_item_get_ellipsize_mode() * instead. * - * Return value: the current ellipsize mode of @shell + * Returns: the current ellipsize mode of @shell * * Since: 2.20 **/ @@ -245,7 +245,7 @@ gtk_tool_shell_get_ellipsize_mode (GtkToolShell *shell) * call this function directly, but rely on gtk_tool_item_get_text_size_group() * instead. * - * Return value: (transfer none): the current text size group of @shell + * Returns: (transfer none): the current text size group of @shell * * Since: 2.20 **/ diff --git a/gtk/gtktrashmonitor.c b/gtk/gtktrashmonitor.c index 539e496798..06dfff66a8 100644 --- a/gtk/gtktrashmonitor.c +++ b/gtk/gtktrashmonitor.c @@ -208,7 +208,7 @@ _gtk_trash_monitor_init (GtkTrashMonitor *monitor) /** * _gtk_trash_monitor_get: * - * Return value: (transfer full): a new reference to the singleton + * Returns: (transfer full): a new reference to the singleton * #GtkTrashMonitor object. Be sure to call g_object_unref() on it when you are * done with the trash monitor. */ @@ -232,7 +232,7 @@ _gtk_trash_monitor_get (void) * _gtk_trash_monitor_get_icon: * @monitor: a #GtkTrashMonitor * - * Return value: (transfer full): the #GIcon that should be used to represent + * Returns: (transfer full): the #GIcon that should be used to represent * the state of the trash folder on screen, based on whether there is trash or * not. */ @@ -255,7 +255,7 @@ _gtk_trash_monitor_get_icon (GtkTrashMonitor *monitor) * _gtk_trash_monitor_get_has_trash: * @monitor: a #GtkTrashMonitor * - * Return value: #TRUE if there is trash in the trash:/// folder, or #FALSE otherwise. + * Returns: #TRUE if there is trash in the trash:/// folder, or #FALSE otherwise. */ gboolean _gtk_trash_monitor_get_has_trash (GtkTrashMonitor *monitor) diff --git a/gtk/gtktreednd.c b/gtk/gtktreednd.c index 0e1d2efc5c..57b6240855 100644 --- a/gtk/gtktreednd.c +++ b/gtk/gtktreednd.c @@ -108,7 +108,7 @@ gtk_tree_drag_dest_get_type (void) * the source of a DND operation. If the source doesn’t implement * this interface, the row is assumed draggable. * - * Return value: %TRUE if the row can be dragged + * Returns: %TRUE if the row can be dragged **/ gboolean gtk_tree_drag_source_row_draggable (GtkTreeDragSource *drag_source, @@ -139,7 +139,7 @@ gtk_tree_drag_source_row_draggable (GtkTreeDragSource *drag_source, * some model-specific reason. Should robustly handle a @path no * longer found in the model! * - * Return value: %TRUE if the row was successfully deleted + * Returns: %TRUE if the row was successfully deleted **/ gboolean gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source, @@ -165,7 +165,7 @@ gtk_tree_drag_source_drag_data_delete (GtkTreeDragSource *drag_source, * the required type of the data. Should robustly handle a @path no * longer found in the model! * - * Return value: %TRUE if data of the required type was provided + * Returns: %TRUE if data of the required type was provided **/ gboolean gtk_tree_drag_source_drag_data_get (GtkTreeDragSource *drag_source, @@ -194,7 +194,7 @@ gtk_tree_drag_source_drag_data_get (GtkTreeDragSource *drag_source, * not created for some model-specific reason. Should robustly handle * a @dest no longer found in the model! * - * Return value: whether a new row was created before position @dest + * Returns: whether a new row was created before position @dest **/ gboolean gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest *drag_dest, @@ -223,7 +223,7 @@ gtk_tree_drag_dest_drag_data_received (GtkTreeDragDest *drag_dest, * exist; the return value will almost certainly be %FALSE if the * parent of @dest_path doesn’t exist, though. * - * Return value: %TRUE if a drop is possible before @dest_path + * Returns: %TRUE if a drop is possible before @dest_path **/ gboolean gtk_tree_drag_dest_row_drop_possible (GtkTreeDragDest *drag_dest, @@ -256,7 +256,7 @@ struct _TreeRowData * Sets selection data of target type %GTK_TREE_MODEL_ROW. Normally used * in a drag_data_get handler. * - * Return value: %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row + * Returns: %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row **/ gboolean gtk_tree_set_row_drag_data (GtkSelectionData *selection_data, @@ -318,7 +318,7 @@ gtk_tree_set_row_drag_data (GtkSelectionData *selection_data, * in from the current process. The returned path must be freed with * gtk_tree_path_free(). * - * Return value: %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and + * Returns: %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and * is otherwise valid **/ gboolean diff --git a/gtk/gtktreemenu.c b/gtk/gtktreemenu.c index 67d2c5ccf0..0cbf64e8db 100644 --- a/gtk/gtktreemenu.c +++ b/gtk/gtktreemenu.c @@ -1564,7 +1564,7 @@ gtk_tree_menu_set_model_internal (GtkTreeMenu *menu, * * Creates a new #GtkTreeMenu. * - * Return value: A newly created #GtkTreeMenu with no model or root. + * Returns: A newly created #GtkTreeMenu with no model or root. * * Since: 3.0 */ @@ -1580,7 +1580,7 @@ _gtk_tree_menu_new (void) * * Creates a new #GtkTreeMenu using @area to render its cells. * - * Return value: A newly created #GtkTreeMenu with no model or root. + * Returns: A newly created #GtkTreeMenu with no model or root. * * Since: 3.0 */ @@ -1600,7 +1600,7 @@ _gtk_tree_menu_new_with_area (GtkCellArea *area) * * Creates a new #GtkTreeMenu hierarchy from the provided @model and @root using @area to render its cells. * - * Return value: A newly created #GtkTreeMenu. + * Returns: A newly created #GtkTreeMenu. * * Since: 3.0 */ @@ -1643,7 +1643,7 @@ _gtk_tree_menu_set_model (GtkTreeMenu *menu, * * Gets the @model currently used for the menu heirarhcy. * - * Return value: (transfer none): the #GtkTreeModel which is used + * Returns: (transfer none): the #GtkTreeModel which is used * for @menu’s hierarchy. * * Since: 3.0 @@ -1699,7 +1699,7 @@ _gtk_tree_menu_set_root (GtkTreeMenu *menu, * Gets the @root path for @menu’s hierarchy, or returns %NULL if @menu * has no model or is building a heirarchy for the entire model. * * - * Return value: (transfer full) (allow-none): A newly created #GtkTreePath + * Returns: (transfer full) (allow-none): A newly created #GtkTreePath * pointing to the root of @menu which must be freed with gtk_tree_path_free(). * * Since: 3.0 @@ -1725,7 +1725,7 @@ _gtk_tree_menu_get_root (GtkTreeMenu *menu) * * Gets whether this menu is build with a leading tearoff menu item. * - * Return value: %TRUE if the menu has a tearoff item. + * Returns: %TRUE if the menu has a tearoff item. * * Since: 3.0 */ @@ -1777,7 +1777,7 @@ _gtk_tree_menu_set_tearoff (GtkTreeMenu *menu, * Gets the wrap width which is used to determine the number of columns * for @menu. If the wrap width is larger than 1, @menu is in table mode. * - * Return value: the wrap width. + * Returns: the wrap width. * * Since: 3.0 */ @@ -1832,7 +1832,7 @@ _gtk_tree_menu_set_wrap_width (GtkTreeMenu *menu, * The row span column contains integers which indicate how many rows * a menu item should span. * - * Return value: the column in @menu’s model containing row span information, or -1. + * Returns: the column in @menu’s model containing row span information, or -1. * * Since: 3.0 */ @@ -1888,7 +1888,7 @@ _gtk_tree_menu_set_row_span_column (GtkTreeMenu *menu, * The column span column contains integers which indicate how many columns * a menu item should span. * - * Return value: the column in @menu’s model containing column span information, or -1. + * Returns: the column in @menu’s model containing column span information, or -1. * * Since: 3.0 */ @@ -1942,7 +1942,7 @@ _gtk_tree_menu_set_column_span_column (GtkTreeMenu *menu, * * Gets the current #GtkTreeViewRowSeparatorFunc separator function. * - * Return value: the current row separator function. + * Returns: the current row separator function. * * Since: 3.0 */ @@ -1999,7 +1999,7 @@ _gtk_tree_menu_set_row_separator_func (GtkTreeMenu *menu, * * Gets the current #GtkTreeMenuHeaderFunc header function. * - * Return value: the current header function. + * Returns: the current header function. * * Since: 3.0 */ diff --git a/gtk/gtktreemenu.h b/gtk/gtktreemenu.h index 674ce01e70..3040d0d4b0 100644 --- a/gtk/gtktreemenu.h +++ b/gtk/gtktreemenu.h @@ -54,7 +54,7 @@ typedef struct _GtkTreeMenuPrivate GtkTreeMenuPrivate; * which has children should be replicated as a header item in the * child menu. * - * Return value: %TRUE if @iter should have an activatable header menu + * Returns: %TRUE if @iter should have an activatable header menu * item created for it in a submenu. */ typedef gboolean (*GtkTreeMenuHeaderFunc) (GtkTreeModel *model, diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c index 874de5fe57..6d159ef1e1 100644 --- a/gtk/gtktreemodel.c +++ b/gtk/gtktreemodel.c @@ -585,7 +585,7 @@ rows_reordered_marshal (GClosure *closure, * Creates a new #GtkTreePath-struct. * This refers to a row. * - * Return value: A newly created #GtkTreePath-struct. + * Returns: A newly created #GtkTreePath-struct. */ GtkTreePath * gtk_tree_path_new (void) @@ -611,7 +611,7 @@ gtk_tree_path_new (void) * child of that 11th child, and the 1st child of that 5th child. * If an invalid path string is passed in, %NULL is returned. * - * Return value: A newly-created #GtkTreePath-struct, or %NULL + * Returns: A newly-created #GtkTreePath-struct, or %NULL */ GtkTreePath * gtk_tree_path_new_from_string (const gchar *path) @@ -659,7 +659,7 @@ gtk_tree_path_new_from_string (const gchar *path) * * Creates a new path with @first_index and @varargs as indices. * - * Return value: A newly created #GtkTreePath-struct + * Returns: A newly created #GtkTreePath-struct * * Since: 2.2 */ @@ -694,7 +694,7 @@ gtk_tree_path_new_from_indices (gint first_index, * * Creates a new path with the given @indices array of @length. * - * Return value: A newly created #GtkTreePath-struct + * Returns: A newly created #GtkTreePath-struct * * Since: 3.12 */ @@ -725,7 +725,7 @@ gtk_tree_path_new_from_indicesv (gint *indices, * For example, “4:10:0:3” would be an acceptable * return value for this string. * - * Return value: A newly-allocated string. + * Returns: A newly-allocated string. * Must be freed with g_free(). */ gchar * @@ -763,7 +763,7 @@ gtk_tree_path_to_string (GtkTreePath *path) * * The string representation of this path is “0”. * - * Return value: A new #GtkTreePath-struct + * Returns: A new #GtkTreePath-struct */ GtkTreePath * gtk_tree_path_new_first (void) @@ -841,7 +841,7 @@ gtk_tree_path_prepend_index (GtkTreePath *path, * * Returns the current depth of @path. * - * Return value: The depth of @path + * Returns: The depth of @path */ gint gtk_tree_path_get_depth (GtkTreePath *path) @@ -862,7 +862,7 @@ gtk_tree_path_get_depth (GtkTreePath *path) * * The length of the array can be obtained with gtk_tree_path_get_depth(). * - * Return value: The current indices, or %NULL + * Returns: The current indices, or %NULL */ gint * gtk_tree_path_get_indices (GtkTreePath *path) @@ -884,7 +884,7 @@ gtk_tree_path_get_indices (GtkTreePath *path) * It also returns the number of elements in the array. * The array should not be freed. * - * Return value: (array length=depth) (transfer none): The current + * Returns: (array length=depth) (transfer none): The current * indices, or %NULL * * Since: 3.0 @@ -923,7 +923,7 @@ gtk_tree_path_free (GtkTreePath *path) * * Creates a new #GtkTreePath-struct as a copy of @path. * - * Return value: a new #GtkTreePath-struct + * Returns: a new #GtkTreePath-struct */ GtkTreePath * gtk_tree_path_copy (const GtkTreePath *path) @@ -955,7 +955,7 @@ G_DEFINE_BOXED_TYPE (GtkTreePath, gtk_tree_path, * If @b appears before @a, then 1 is returned. * If the two nodes are equal, then 0 is returned. * - * Return value: the relative positions of @a and @b + * Returns: the relative positions of @a and @b */ gint gtk_tree_path_compare (const GtkTreePath *a, @@ -987,7 +987,7 @@ gtk_tree_path_compare (const GtkTreePath *a, * * Returns %TRUE if @descendant is a descendant of @path. * - * Return value: %TRUE if @descendant is contained inside @path + * Returns: %TRUE if @descendant is contained inside @path */ gboolean gtk_tree_path_is_ancestor (GtkTreePath *path, @@ -1020,7 +1020,7 @@ gtk_tree_path_is_ancestor (GtkTreePath *path, * * Returns %TRUE if @path is a descendant of @ancestor. * - * Return value: %TRUE if @ancestor contains @path somewhere below it + * Returns: %TRUE if @ancestor contains @path somewhere below it */ gboolean gtk_tree_path_is_descendant (GtkTreePath *path, @@ -1069,7 +1069,7 @@ gtk_tree_path_next (GtkTreePath *path) * Moves the @path to point to the previous node at the * current depth, if it exists. * - * Return value: %TRUE if @path has a previous node, and + * Returns: %TRUE if @path has a previous node, and * the move was made */ gboolean @@ -1094,7 +1094,7 @@ gtk_tree_path_prev (GtkTreePath *path) * * Moves the @path to point to its parent node, if it has a parent. * - * Return value: %TRUE if @path has a parent, and the move was made + * Returns: %TRUE if @path has a parent, and the move was made */ gboolean gtk_tree_path_up (GtkTreePath *path) @@ -1134,7 +1134,7 @@ gtk_tree_path_down (GtkTreePath *path) * (`GtkTreeIter new_iter = iter;`). * You must free this iter with gtk_tree_iter_free(). * - * Return value: a newly-allocated copy of @iter + * Returns: a newly-allocated copy of @iter */ GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter) @@ -1179,7 +1179,7 @@ G_DEFINE_BOXED_TYPE (GtkTreeIter, gtk_tree_iter, * The flags supported should not change during the lifetime * of the @tree_model. * - * Return value: the flags supported by this interface + * Returns: the flags supported by this interface */ GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model) @@ -1201,7 +1201,7 @@ gtk_tree_model_get_flags (GtkTreeModel *tree_model) * * Returns the number of columns supported by @tree_model. * - * Return value: the number of columns + * Returns: the number of columns */ gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model) @@ -1222,7 +1222,7 @@ gtk_tree_model_get_n_columns (GtkTreeModel *tree_model) * * Returns the type of the column. * - * Return value: (transfer none): the type of the column + * Returns: (transfer none): the type of the column */ GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model, @@ -1248,7 +1248,7 @@ gtk_tree_model_get_column_type (GtkTreeModel *tree_model, * Sets @iter to a valid iterator pointing to @path. If @path does * not exist, @iter is set to an invalid iterator and %FALSE is returned. * - * Return value: %TRUE, if @iter was set + * Returns: %TRUE, if @iter was set */ gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model, @@ -1279,7 +1279,7 @@ gtk_tree_model_get_iter (GtkTreeModel *tree_model, * Sets @iter to a valid iterator pointing to @path_string, if it * exists. Otherwise, @iter is left invalid and %FALSE is returned. * - * Return value: %TRUE, if @iter was set + * Returns: %TRUE, if @iter was set */ gboolean gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model, @@ -1314,7 +1314,7 @@ gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model, * For example, “4:10:0:3” would be an acceptable * return value for this string. * - * Return value: a newly-allocated string. + * Returns: a newly-allocated string. * Must be freed with g_free(). * * Since: 2.2 @@ -1348,7 +1348,7 @@ gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model, * (the one at the path "0") and returns %TRUE. Returns * %FALSE if the tree is empty. * - * Return value: %TRUE, if @iter was set + * Returns: %TRUE, if @iter was set */ gboolean gtk_tree_model_get_iter_first (GtkTreeModel *tree_model, @@ -1376,7 +1376,7 @@ gtk_tree_model_get_iter_first (GtkTreeModel *tree_model, * * This path should be freed with gtk_tree_path_free(). * - * Return value: a newly-created #GtkTreePath-struct + * Returns: a newly-created #GtkTreePath-struct */ GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model, @@ -1433,7 +1433,7 @@ gtk_tree_model_get_value (GtkTreeModel *tree_model, * If there is no next @iter, %FALSE is returned and @iter is set * to be invalid. * - * Return value: %TRUE if @iter has been changed to the next node + * Returns: %TRUE if @iter has been changed to the next node */ gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model, @@ -1481,7 +1481,7 @@ gtk_tree_model_iter_previous_default (GtkTreeModel *tree_model, * If there is no previous @iter, %FALSE is returned and @iter is * set to be invalid. * - * Return value: %TRUE if @iter has been changed to the previous node + * Returns: %TRUE if @iter has been changed to the previous node * * Since: 3.0 */ @@ -1520,7 +1520,7 @@ gtk_tree_model_iter_previous (GtkTreeModel *tree_model, * If @parent is %NULL returns the first node, equivalent to * `gtk_tree_model_get_iter_first (tree_model, iter);` * - * Return value: %TRUE, if @child has been set to the first child + * Returns: %TRUE, if @child has been set to the first child */ gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model, @@ -1547,7 +1547,7 @@ gtk_tree_model_iter_children (GtkTreeModel *tree_model, * * Returns %TRUE if @iter has children, %FALSE otherwise. * - * Return value: %TRUE if @iter has children + * Returns: %TRUE if @iter has children */ gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model, @@ -1574,7 +1574,7 @@ gtk_tree_model_iter_has_child (GtkTreeModel *tree_model, * As a special case, if @iter is %NULL, then the number * of toplevel nodes is returned. * - * Return value: the number of children of @iter + * Returns: the number of children of @iter */ gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model, @@ -1605,7 +1605,7 @@ gtk_tree_model_iter_n_children (GtkTreeModel *tree_model, * special case, if @parent is %NULL, then the @n-th root node * is set. * - * Return value: %TRUE, if @parent has an @n-th child + * Returns: %TRUE, if @parent has an @n-th child */ gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model, @@ -1640,7 +1640,7 @@ gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model, * @child will remain a valid node after this function has been * called. * - * Return value: %TRUE, if @iter is set to the parent of @child + * Returns: %TRUE, if @iter is set to the parent of @child */ gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model, @@ -2277,7 +2277,7 @@ gtk_tree_row_reference_unref_path (GtkTreePath *path, * propagated, and the path is updated appropriately. If * @path isn’t a valid path in @model, then %NULL is returned. * - * Return value: a newly allocated #GtkTreeRowReference, or %NULL + * Returns: a newly allocated #GtkTreeRowReference, or %NULL */ GtkTreeRowReference * gtk_tree_row_reference_new (GtkTreeModel *model, @@ -2324,7 +2324,7 @@ gtk_tree_row_reference_new (GtkTreeModel *model, * need to carefully monitor exactly when a row reference updates * itself, and is not generally needed by most applications. * - * Return value: a newly allocated #GtkTreeRowReference, or %NULL + * Returns: a newly allocated #GtkTreeRowReference, or %NULL */ GtkTreeRowReference * gtk_tree_row_reference_new_proxy (GObject *proxy, @@ -2390,7 +2390,7 @@ gtk_tree_row_reference_new_proxy (GObject *proxy, * Returns a path that the row reference currently points to, * or %NULL if the path pointed to is no longer valid. * - * Return value: a current path, or %NULL + * Returns: a current path, or %NULL */ GtkTreePath * gtk_tree_row_reference_get_path (GtkTreeRowReference *reference) @@ -2412,7 +2412,7 @@ gtk_tree_row_reference_get_path (GtkTreeRowReference *reference) * * Returns the model that the row reference is monitoring. * - * Return value: (transfer none): the model + * Returns: (transfer none): the model * * Since: 2.8 */ @@ -2431,7 +2431,7 @@ gtk_tree_row_reference_get_model (GtkTreeRowReference *reference) * Returns %TRUE if the @reference is non-%NULL and refers to * a current valid path. * - * Return value: %TRUE if @reference points to a valid path + * Returns: %TRUE if @reference points to a valid path */ gboolean gtk_tree_row_reference_valid (GtkTreeRowReference *reference) @@ -2449,7 +2449,7 @@ gtk_tree_row_reference_valid (GtkTreeRowReference *reference) * * Copies a #GtkTreeRowReference. * - * Return value: a copy of @reference + * Returns: a copy of @reference * * Since: 2.2 */ diff --git a/gtk/gtktreemodel.h b/gtk/gtktreemodel.h index d702b3b5a8..9eef7c62ce 100644 --- a/gtk/gtktreemodel.h +++ b/gtk/gtktreemodel.h @@ -52,7 +52,7 @@ typedef struct _GtkTreeModelIface GtkTreeModelIface; * Type of the callback passed to gtk_tree_model_foreach() to * iterate over the rows in a tree model. * - * Return value: %TRUE to stop iterating, %FALSE to continue + * Returns: %TRUE to stop iterating, %FALSE to continue * */ typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data); diff --git a/gtk/gtktreemodelfilter.c b/gtk/gtktreemodelfilter.c index 3acd21aa04..7e4a8716ef 100644 --- a/gtk/gtktreemodelfilter.c +++ b/gtk/gtktreemodelfilter.c @@ -3770,7 +3770,7 @@ gtk_tree_model_filter_set_root (GtkTreeModelFilter *filter, * Creates a new #GtkTreeModel, with @child_model as the child_model * and @root as the virtual root. * - * Return value: (transfer full): A new #GtkTreeModel. + * Returns: (transfer full): A new #GtkTreeModel. * * Since: 2.4 */ @@ -3792,7 +3792,7 @@ gtk_tree_model_filter_new (GtkTreeModel *child_model, * * Returns a pointer to the child model of @filter. * - * Return value: (transfer none): A pointer to a #GtkTreeModel. + * Returns: (transfer none): A pointer to a #GtkTreeModel. * * Since: 2.4 */ @@ -3948,7 +3948,7 @@ gtk_tree_model_filter_set_visible_column (GtkTreeModelFilter *filter, * row pointed at by @child_iter. If @filter_iter was not set, %FALSE is * returned. * - * Return value: %TRUE, if @filter_iter was set, i.e. if @child_iter is a + * Returns: %TRUE, if @filter_iter was set, i.e. if @child_iter is a * valid iterator pointing to a visible row in child model. * * Since: 2.4 @@ -4130,7 +4130,7 @@ gtk_real_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filte * child model or points to a row which is not visible in @filter, then %NULL * is returned. * - * Return value: A newly allocated #GtkTreePath, or %NULL. + * Returns: A newly allocated #GtkTreePath, or %NULL. * * Since: 2.4 */ @@ -4173,7 +4173,7 @@ gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter, * point to the same location in the model not being filtered. If @filter_path * does not point to a location in the child model, %NULL is returned. * - * Return value: A newly allocated #GtkTreePath, or %NULL. + * Returns: A newly allocated #GtkTreePath, or %NULL. * * Since: 2.4 */ diff --git a/gtk/gtktreemodelsort.c b/gtk/gtktreemodelsort.c index 368cbd2534..2a7de1e434 100644 --- a/gtk/gtktreemodelsort.c +++ b/gtk/gtktreemodelsort.c @@ -531,7 +531,7 @@ gtk_tree_model_sort_drag_source_init (GtkTreeDragSourceIface *iface) * * Creates a new #GtkTreeModel, with @child_model as the child model. * - * Return value: (transfer full): A new #GtkTreeModel. + * Returns: (transfer full): A new #GtkTreeModel. */ GtkTreeModel * gtk_tree_model_sort_new_with_model (GtkTreeModel *child_model) @@ -2206,7 +2206,7 @@ gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort, * * Returns the model the #GtkTreeModelSort is sorting. * - * Return value: (transfer none): the "child model" being sorted + * Returns: (transfer none): the "child model" being sorted **/ GtkTreeModel * gtk_tree_model_sort_get_model (GtkTreeModelSort *tree_model) @@ -2288,7 +2288,7 @@ gtk_real_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_mode * point to the same row in the sorted model. If @child_path isn’t a valid * path on the child model, then %NULL is returned. * - * Return value: A newly allocated #GtkTreePath, or %NULL + * Returns: A newly allocated #GtkTreePath, or %NULL **/ GtkTreePath * gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort, @@ -2311,7 +2311,7 @@ gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sor * the row pointed at by @child_iter. If @sort_iter was not set, %FALSE * is returned. Note: a boolean is only returned since 2.14. * - * Return value: %TRUE, if @sort_iter was set, i.e. if @sort_iter is a + * Returns: %TRUE, if @sort_iter was set, i.e. if @sort_iter is a * valid iterator pointer to a visible row in the child model. **/ gboolean @@ -2361,7 +2361,7 @@ gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sor * sorted. If @sorted_path does not point to a location in the child model, * %NULL is returned. * - * Return value: A newly allocated #GtkTreePath, or %NULL + * Returns: A newly allocated #GtkTreePath, or %NULL **/ GtkTreePath * gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort, @@ -2772,7 +2772,7 @@ gtk_tree_model_sort_iter_is_valid_helper (GtkTreeIter *iter, * * Checks if the given iter is a valid iter for this #GtkTreeModelSort. * - * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid. + * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. * * Since: 2.2 **/ diff --git a/gtk/gtktreeselection.c b/gtk/gtktreeselection.c index 99c982396c..4096489d70 100644 --- a/gtk/gtktreeselection.c +++ b/gtk/gtktreeselection.c @@ -221,7 +221,7 @@ gtk_tree_selection_get_property (GObject *object, * Creates a new #GtkTreeSelection object. This function should not be invoked, * as each #GtkTreeView will create its own #GtkTreeSelection. * - * Return value: A newly created #GtkTreeSelection object. + * Returns: A newly created #GtkTreeSelection object. **/ GtkTreeSelection* _gtk_tree_selection_new (void) @@ -240,7 +240,7 @@ _gtk_tree_selection_new (void) * Creates a new #GtkTreeSelection object. This function should not be invoked, * as each #GtkTreeView will create its own #GtkTreeSelection. * - * Return value: A newly created #GtkTreeSelection object. + * Returns: A newly created #GtkTreeSelection object. **/ GtkTreeSelection* _gtk_tree_selection_new_with_tree_view (GtkTreeView *tree_view) @@ -363,7 +363,7 @@ gtk_tree_selection_set_mode (GtkTreeSelection *selection, * Gets the selection mode for @selection. See * gtk_tree_selection_set_mode(). * - * Return value: the current selection mode + * Returns: the current selection mode **/ GtkSelectionMode gtk_tree_selection_get_mode (GtkTreeSelection *selection) @@ -413,7 +413,7 @@ gtk_tree_selection_set_select_function (GtkTreeSelection *selection, * * Returns the current selection function. * - * Return value: The function. + * Returns: The function. * * Since: 2.14 **/ @@ -431,7 +431,7 @@ gtk_tree_selection_get_select_function (GtkTreeSelection *selection) * * Returns the user data for the selection function. * - * Return value: The user data. + * Returns: The user data. **/ gpointer gtk_tree_selection_get_user_data (GtkTreeSelection *selection) @@ -447,7 +447,7 @@ gtk_tree_selection_get_user_data (GtkTreeSelection *selection) * * Returns the tree view associated with @selection. * - * Return value: (transfer none): A #GtkTreeView + * Returns: (transfer none): A #GtkTreeView **/ GtkTreeView * gtk_tree_selection_get_tree_view (GtkTreeSelection *selection) @@ -469,7 +469,7 @@ gtk_tree_selection_get_tree_view (GtkTreeSelection *selection) * with the current model as a convenience. This function will not work if you * use @selection is #GTK_SELECTION_MULTIPLE. * - * Return value: TRUE, if there is a selected node. + * Returns: TRUE, if there is a selected node. **/ gboolean gtk_tree_selection_get_selected (GtkTreeSelection *selection, @@ -546,7 +546,7 @@ gtk_tree_selection_get_selected (GtkTreeSelection *selection, * g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free); * ]| * - * Return value: (element-type GtkTreePath) (transfer full): A #GList containing a #GtkTreePath for each selected row. + * Returns: (element-type GtkTreePath) (transfer full): A #GList containing a #GtkTreePath for each selected row. * * Since: 2.2 **/ @@ -668,7 +668,7 @@ gtk_tree_selection_count_selected_rows_helper (GtkRBTree *tree, * * Returns the number of rows that have been selected in @tree. * - * Return value: The number of rows selected. + * Returns: The number of rows selected. * * Since: 2.2 **/ @@ -1019,7 +1019,7 @@ gtk_tree_selection_unselect_iter (GtkTreeSelection *selection, * Returns %TRUE if the row pointed to by @path is currently selected. If @path * does not point to a valid location, %FALSE is returned * - * Return value: %TRUE if @path is selected. + * Returns: %TRUE if @path is selected. **/ gboolean gtk_tree_selection_path_is_selected (GtkTreeSelection *selection, @@ -1059,7 +1059,7 @@ gtk_tree_selection_path_is_selected (GtkTreeSelection *selection, * * Returns %TRUE if the row at @iter is currently selected. * - * Return value: %TRUE, if @iter is selected + * Returns: %TRUE, if @iter is selected **/ gboolean gtk_tree_selection_iter_is_selected (GtkTreeSelection *selection, diff --git a/gtk/gtktreesortable.c b/gtk/gtktreesortable.c index 0736bb4c9a..1cb42741fb 100644 --- a/gtk/gtktreesortable.c +++ b/gtk/gtktreesortable.c @@ -117,7 +117,7 @@ gtk_tree_sortable_sort_column_changed (GtkTreeSortable *sortable) * %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or * %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. * - * Return value: %TRUE if the sort column is not one of the special sort + * Returns: %TRUE if the sort column is not one of the special sort * column ids. **/ gboolean @@ -246,7 +246,7 @@ gtk_tree_sortable_set_default_sort_func (GtkTreeSortable *sortable, * primarily by GtkTreeViewColumns in order to determine if a model can * go back to the default state, or not. * - * Return value: %TRUE, if the model has a default sort function + * Returns: %TRUE, if the model has a default sort function */ gboolean gtk_tree_sortable_has_default_sort_func (GtkTreeSortable *sortable) diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c index 2fbc6a6a29..1ef7a3989c 100644 --- a/gtk/gtktreestore.c +++ b/gtk/gtktreestore.c @@ -308,7 +308,7 @@ gtk_tree_store_init (GtkTreeStore *tree_store) * GDK_TYPE_PIXBUF);` will create a new #GtkTreeStore with three columns, of type * #gint, #gchararray, and #GdkPixbuf respectively. * - * Return value: a new #GtkTreeStore + * Returns: a new #GtkTreeStore **/ GtkTreeStore * gtk_tree_store_new (gint n_columns, @@ -348,7 +348,7 @@ gtk_tree_store_new (gint n_columns, * * Non vararg creation function. Used primarily by language bindings. * - * Return value: (transfer full): a new #GtkTreeStore + * Returns: (transfer full): a new #GtkTreeStore **/ GtkTreeStore * gtk_tree_store_newv (gint n_columns, @@ -1196,7 +1196,7 @@ gtk_tree_store_set (GtkTreeStore *tree_store, * next valid row at that level, or invalidated if it previously pointed to the * last one. * - * Return value: %TRUE if @iter is still valid, %FALSE if not. + * Returns: %TRUE if @iter is still valid, %FALSE if not. **/ gboolean gtk_tree_store_remove (GtkTreeStore *tree_store, @@ -1777,7 +1777,7 @@ gtk_tree_store_append (GtkTreeStore *tree_store, * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the * parent (or grandparent or great-grandparent) of @descendant. * - * Return value: %TRUE, if @iter is an ancestor of @descendant + * Returns: %TRUE, if @iter is an ancestor of @descendant **/ gboolean gtk_tree_store_is_ancestor (GtkTreeStore *tree_store, @@ -1801,7 +1801,7 @@ gtk_tree_store_is_ancestor (GtkTreeStore *tree_store, * Returns the depth of @iter. This will be 0 for anything on the root level, 1 * for anything down a level, etc. * - * Return value: The depth of @iter + * Returns: The depth of @iter **/ gint gtk_tree_store_iter_depth (GtkTreeStore *tree_store, @@ -1914,7 +1914,7 @@ gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter, * * Checks if the given iter is a valid iter for this #GtkTreeStore. * - * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid. + * Returns: %TRUE if the iter is valid, %FALSE if the iter is invalid. * * Since: 2.2 **/ diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c index 968a1bf406..953f0709d4 100644 --- a/gtk/gtktreeview.c +++ b/gtk/gtktreeview.c @@ -8249,7 +8249,7 @@ gtk_tree_view_set_fixed_height_mode (GtkTreeView *tree_view, * * Returns whether fixed height mode is turned on for @tree_view. * - * Return value: %TRUE if @tree_view is in fixed height mode + * Returns: %TRUE if @tree_view is in fixed height mode * * Since: 2.6 **/ @@ -11215,7 +11215,7 @@ gtk_tree_view_adjustment_changed (GtkAdjustment *adjustment, * * Creates a new #GtkTreeView widget. * - * Return value: A newly created #GtkTreeView widget. + * Returns: A newly created #GtkTreeView widget. **/ GtkWidget * gtk_tree_view_new (void) @@ -11229,7 +11229,7 @@ gtk_tree_view_new (void) * * Creates a new #GtkTreeView widget with the model initialized to @model. * - * Return value: A newly created #GtkTreeView widget. + * Returns: A newly created #GtkTreeView widget. **/ GtkWidget * gtk_tree_view_new_with_model (GtkTreeModel *model) @@ -11247,7 +11247,7 @@ gtk_tree_view_new_with_model (GtkTreeModel *model) * Returns the model the #GtkTreeView is based on. Returns %NULL if the * model is unset. * - * Return value: (transfer none): A #GtkTreeModel, or %NULL if none is currently being used. + * Returns: (transfer none): A #GtkTreeModel, or %NULL if none is currently being used. **/ GtkTreeModel * gtk_tree_view_get_model (GtkTreeView *tree_view) @@ -11417,7 +11417,7 @@ gtk_tree_view_set_model (GtkTreeView *tree_view, * * Gets the #GtkTreeSelection associated with @tree_view. * - * Return value: (transfer none): A #GtkTreeSelection object. + * Returns: (transfer none): A #GtkTreeSelection object. **/ GtkTreeSelection * gtk_tree_view_get_selection (GtkTreeView *tree_view) @@ -11433,7 +11433,7 @@ gtk_tree_view_get_selection (GtkTreeView *tree_view) * * Gets the #GtkAdjustment currently being used for the horizontal aspect. * - * Return value: (transfer none): A #GtkAdjustment object, or %NULL + * Returns: (transfer none): A #GtkAdjustment object, or %NULL * if none is currently being used. * * Deprecated: 3.0: Use gtk_scrollable_get_hadjustment() @@ -11509,7 +11509,7 @@ gtk_tree_view_do_set_hadjustment (GtkTreeView *tree_view, * * Gets the #GtkAdjustment currently being used for the vertical aspect. * - * Return value: (transfer none): A #GtkAdjustment object, or %NULL + * Returns: (transfer none): A #GtkAdjustment object, or %NULL * if none is currently being used. * * Deprecated: 3.0: Use gtk_scrollable_get_vadjustment() @@ -11586,7 +11586,7 @@ gtk_tree_view_do_set_vadjustment (GtkTreeView *tree_view, * * Returns %TRUE if the headers on the @tree_view are visible. * - * Return value: Whether the headers are visible or not. + * Returns: Whether the headers are visible or not. **/ gboolean gtk_tree_view_get_headers_visible (GtkTreeView *tree_view) @@ -11722,7 +11722,7 @@ gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view, * * Returns whether all header columns are clickable. * - * Return value: %TRUE if all header columns are clickable, otherwise %FALSE + * Returns: %TRUE if all header columns are clickable, otherwise %FALSE * * Since: 2.10 **/ @@ -11782,7 +11782,7 @@ gtk_tree_view_set_rules_hint (GtkTreeView *tree_view, * * Gets the setting set by gtk_tree_view_set_rules_hint(). * - * Return value: %TRUE if rules are useful for the user of this tree + * Returns: %TRUE if rules are useful for the user of this tree **/ gboolean gtk_tree_view_get_rules_hint (GtkTreeView *tree_view) @@ -11824,7 +11824,7 @@ gtk_tree_view_set_activate_on_single_click (GtkTreeView *tree_view, * * Gets the setting set by gtk_tree_view_set_activate_on_single_click(). * - * Return value: %TRUE if row-activated will be emitted on a single click + * Returns: %TRUE if row-activated will be emitted on a single click * * Since: 3.8 **/ @@ -11848,7 +11848,7 @@ gtk_tree_view_get_activate_on_single_click (GtkTreeView *tree_view) * mode enabled, then @column must have its “sizing” property set to be * GTK_TREE_VIEW_COLUMN_FIXED. * - * Return value: The number of columns in @tree_view after appending. + * Returns: The number of columns in @tree_view after appending. **/ gint gtk_tree_view_append_column (GtkTreeView *tree_view, @@ -11891,7 +11891,7 @@ _gtk_tree_view_reset_header_styles (GtkTreeView *tree_view) * * Removes @column from @tree_view. * - * Return value: The number of columns in @tree_view after removing. + * Returns: The number of columns in @tree_view after removing. **/ gint gtk_tree_view_remove_column (GtkTreeView *tree_view, @@ -11968,7 +11968,7 @@ gtk_tree_view_remove_column (GtkTreeView *tree_view, * “fixed_height” mode enabled, then @column must have its “sizing” property * set to be GTK_TREE_VIEW_COLUMN_FIXED. * - * Return value: The number of columns in @tree_view after insertion. + * Returns: The number of columns in @tree_view after insertion. **/ gint gtk_tree_view_insert_column (GtkTreeView *tree_view, @@ -12042,7 +12042,7 @@ gtk_tree_view_insert_column (GtkTreeView *tree_view, * has “fixed_height” mode enabled, then the new column will have its sizing * property set to be GTK_TREE_VIEW_COLUMN_FIXED. * - * Return value: The number of columns in @tree_view after insertion. + * Returns: The number of columns in @tree_view after insertion. **/ gint gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view, @@ -12098,7 +12098,7 @@ gtk_tree_view_insert_column_with_attributes (GtkTreeView *tree_view, * If @tree_view has “fixed_height” mode enabled, then the new column will have its * “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED. * - * Return value: number of columns in the tree view post-insert + * Returns: number of columns in the tree view post-insert **/ gint gtk_tree_view_insert_column_with_data_func (GtkTreeView *tree_view, @@ -12149,7 +12149,7 @@ gtk_tree_view_get_n_columns (GtkTreeView *tree_view) * * Gets the #GtkTreeViewColumn at the given position in the #tree_view. * - * Return value: (transfer none): The #GtkTreeViewColumn, or %NULL if the + * Returns: (transfer none): The #GtkTreeViewColumn, or %NULL if the * position is outside the range of columns. **/ GtkTreeViewColumn * @@ -12174,7 +12174,7 @@ gtk_tree_view_get_column (GtkTreeView *tree_view, * Returns a #GList of all the #GtkTreeViewColumn s currently in @tree_view. * The returned list must be freed with g_list_free (). * - * Return value: (element-type GtkTreeViewColumn) (transfer container): A list of #GtkTreeViewColumn s + * Returns: (element-type GtkTreeViewColumn) (transfer container): A list of #GtkTreeViewColumn s **/ GList * gtk_tree_view_get_columns (GtkTreeView *tree_view) @@ -12279,7 +12279,7 @@ gtk_tree_view_set_expander_column (GtkTreeView *tree_view, * Returns the column that is the current expander column. * This column has the expander arrow drawn next to it. * - * Return value: (transfer none): The expander column. + * Returns: (transfer none): The expander column. **/ GtkTreeViewColumn * gtk_tree_view_get_expander_column (GtkTreeView *tree_view) @@ -12748,7 +12748,7 @@ gtk_tree_view_real_expand_row (GtkTreeView *tree_view, * * Opens the row so its children are visible. * - * Return value: %TRUE if the row existed and had children + * Returns: %TRUE if the row existed and had children **/ gboolean gtk_tree_view_expand_row (GtkTreeView *tree_view, @@ -12933,7 +12933,7 @@ gtk_tree_view_real_collapse_row (GtkTreeView *tree_view, * * Collapses a row (hides its child rows, if they exist). * - * Return value: %TRUE if the row was collapsed. + * Returns: %TRUE if the row was collapsed. **/ gboolean gtk_tree_view_collapse_row (GtkTreeView *tree_view, @@ -13020,7 +13020,7 @@ gtk_tree_view_map_expanded_rows (GtkTreeView *tree_view, * * Returns %TRUE if the node pointed to by @path is expanded in @tree_view. * - * Return value: %TRUE if #path is expanded. + * Returns: %TRUE if #path is expanded. **/ gboolean gtk_tree_view_row_expanded (GtkTreeView *tree_view, @@ -13047,7 +13047,7 @@ gtk_tree_view_row_expanded (GtkTreeView *tree_view, * Retrieves whether the user can reorder the tree via drag-and-drop. See * gtk_tree_view_set_reorderable(). * - * Return value: %TRUE if the tree can be reordered. + * Returns: %TRUE if the tree can be reordered. **/ gboolean gtk_tree_view_get_reorderable (GtkTreeView *tree_view) @@ -13345,7 +13345,7 @@ gtk_tree_view_set_cursor_on_cell (GtkTreeView *tree_view, * This is used primarily to compare to `event->window` * to confirm that the event on @tree_view is on the right window. * - * Return value: (transfer none): A #GdkWindow, or %NULL when @tree_view + * Returns: (transfer none): A #GdkWindow, or %NULL when @tree_view * hasn’t been realized yet **/ GdkWindow * @@ -13384,7 +13384,7 @@ gtk_tree_view_get_bin_window (GtkTreeView *tree_view) * GtkWidget::query-tooltip), please see * gtk_tree_view_convert_widget_to_bin_window_coords(). * - * Return value: %TRUE if a row exists at that coordinate. + * Returns: %TRUE if a row exists at that coordinate. **/ gboolean gtk_tree_view_get_path_at_pos (GtkTreeView *tree_view, @@ -14019,7 +14019,7 @@ gtk_tree_view_get_visible_range (GtkTreeView *tree_view, * likewise as for gtk_tree_view_get_path_at_pos(). Please see * gtk_tree_view_get_path_at_pos() for more information. * - * Return value: %TRUE if the area at the given coordinates is blank, + * Returns: %TRUE if the area at the given coordinates is blank, * %FALSE otherwise. * * Since: 3.0 @@ -14364,7 +14364,7 @@ gtk_tree_view_get_drag_dest_row (GtkTreeView *tree_view, * meaningful if @tree_view is realized. Therefore this function will always * return %FALSE if @tree_view is not realized or does not have a model. * - * Return value: whether there is a row at the given position, %TRUE if this + * Returns: whether there is a row at the given position, %TRUE if this * is indeed the case. **/ gboolean @@ -14463,7 +14463,7 @@ gtk_tree_view_get_dest_row_at_pos (GtkTreeView *tree_view, * Creates a #cairo_surface_t representation of the row at @path. * This image is used for a drag icon. * - * Return value: (transfer full): a newly-allocated surface of the drag icon. + * Returns: (transfer full): a newly-allocated surface of the drag icon. **/ cairo_surface_t * gtk_tree_view_create_row_drag_icon (GtkTreeView *tree_view, @@ -14706,7 +14706,7 @@ gtk_tree_view_set_enable_search (GtkTreeView *tree_view, * Returns whether or not the tree allows to start interactive searching * by typing in text. * - * Return value: whether or not to let the user search interactively + * Returns: whether or not to let the user search interactively */ gboolean gtk_tree_view_get_enable_search (GtkTreeView *tree_view) @@ -14723,7 +14723,7 @@ gtk_tree_view_get_enable_search (GtkTreeView *tree_view) * * Gets the column searched on by the interactive search code. * - * Return value: the column the interactive search code searches in. + * Returns: the column the interactive search code searches in. */ gint gtk_tree_view_get_search_column (GtkTreeView *tree_view) @@ -14768,7 +14768,7 @@ gtk_tree_view_set_search_column (GtkTreeView *tree_view, * * Returns the compare function currently in use. * - * Return value: the currently used compare function for the search code. + * Returns: the currently used compare function for the search code. */ GtkTreeViewSearchEqualFunc @@ -14817,7 +14817,7 @@ gtk_tree_view_set_search_equal_func (GtkTreeView *tree_view, * entry for @tree_view. In case the built-in entry is being used, %NULL * will be returned. * - * Return value: (transfer none): the entry currently in use as search entry. + * Returns: (transfer none): the entry currently in use as search entry. * * Since: 2.10 */ @@ -14936,7 +14936,7 @@ gtk_tree_view_set_search_position_func (GtkTreeView *tree_view * * Returns the positioning function currently in use. * - * Return value: the currently used function for positioning the search dialog. + * Returns: the currently used function for positioning the search dialog. * * Since: 2.10 */ @@ -15658,7 +15658,7 @@ gtk_tree_view_set_hover_selection (GtkTreeView *tree_view, * * Returns whether hover selection mode is turned on for @tree_view. * - * Return value: %TRUE if @tree_view is in hover selection mode + * Returns: %TRUE if @tree_view is in hover selection mode * * Since: 2.6 **/ @@ -15699,7 +15699,7 @@ gtk_tree_view_set_hover_expand (GtkTreeView *tree_view, * * Returns whether hover expansion mode is turned on for @tree_view. * - * Return value: %TRUE if @tree_view is in hover expansion mode + * Returns: %TRUE if @tree_view is in hover expansion mode * * Since: 2.6 **/ @@ -15742,7 +15742,7 @@ gtk_tree_view_set_rubber_banding (GtkTreeView *tree_view, * selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the * user to select multiple rows by dragging the mouse. * - * Return value: %TRUE if rubber banding in @tree_view is enabled. + * Returns: %TRUE if rubber banding in @tree_view is enabled. * * Since: 2.10 **/ @@ -15759,7 +15759,7 @@ gtk_tree_view_get_rubber_banding (GtkTreeView *tree_view) * Returns whether a rubber banding operation is currently being done * in @tree_view. * - * Return value: %TRUE if a rubber banding operation is currently being + * Returns: %TRUE if a rubber banding operation is currently being * done in @tree_view. * * Since: 2.12 @@ -15782,7 +15782,7 @@ gtk_tree_view_is_rubber_banding_active (GtkTreeView *tree_view) * * Returns the current row separator function. * - * Return value: the current row separator function. + * Returns: the current row separator function. * * Since: 2.6 **/ @@ -15861,7 +15861,7 @@ gtk_tree_view_state_flags_changed (GtkWidget *widget, * * Returns which grid lines are enabled in @tree_view. * - * Return value: a #GtkTreeViewGridLines value indicating which grid lines + * Returns: a #GtkTreeViewGridLines value indicating which grid lines * are enabled. * * Since: 2.10 @@ -15948,7 +15948,7 @@ gtk_tree_view_set_grid_lines (GtkTreeView *tree_view, * * Returns whether or not tree lines are drawn in @tree_view. * - * Return value: %TRUE if tree lines are drawn in @tree_view, %FALSE + * Returns: %TRUE if tree lines are drawn in @tree_view, %FALSE * otherwise. * * Since: 2.10 @@ -16068,7 +16068,7 @@ gtk_tree_view_set_show_expanders (GtkTreeView *tree_view, * * Returns whether or not expanders are drawn in @tree_view. * - * Return value: %TRUE if expanders are drawn in @tree_view, %FALSE + * Returns: %TRUE if expanders are drawn in @tree_view, %FALSE * otherwise. * * Since: 2.12 @@ -16110,7 +16110,7 @@ gtk_tree_view_set_level_indentation (GtkTreeView *tree_view, * Returns the amount, in pixels, of extra indentation for child levels * in @tree_view. * - * Return value: the amount of extra indentation for child levels in + * Returns: the amount of extra indentation for child levels in * @tree_view. A return value of 0 means that this feature is disabled. * * Since: 2.12 @@ -16264,7 +16264,7 @@ gtk_tree_view_set_tooltip_cell (GtkTreeView *tree_view, * that row and the corresponding model. @x and @y will always be converted * to be relative to @tree_view’s bin_window if @keyboard_tooltip is %FALSE. * - * Return value: whether or not the given tooltip context points to a row. + * Returns: whether or not the given tooltip context points to a row. * * Since: 2.12 */ @@ -16423,7 +16423,7 @@ gtk_tree_view_set_tooltip_column (GtkTreeView *tree_view, * Returns the column of @tree_view’s model which is being used for * displaying tooltips on @tree_view’s rows. * - * Return value: the index of the tooltip column that is currently being + * Returns: the index of the tooltip column that is currently being * used, or -1 if this is disabled. * * Since: 2.12 diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c index 58424a2f3b..0e8a94c80d 100644 --- a/gtk/gtktreeviewcolumn.c +++ b/gtk/gtktreeviewcolumn.c @@ -1608,7 +1608,7 @@ _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column, * * Creates a new #GtkTreeViewColumn. * - * Return value: A newly created #GtkTreeViewColumn. + * Returns: A newly created #GtkTreeViewColumn. **/ GtkTreeViewColumn * gtk_tree_view_column_new (void) @@ -1626,7 +1626,7 @@ gtk_tree_view_column_new (void) * * Creates a new #GtkTreeViewColumn using @area to render its cells. * - * Return value: A newly created #GtkTreeViewColumn. + * Returns: A newly created #GtkTreeViewColumn. * * Since: 3.0 */ @@ -1668,7 +1668,7 @@ gtk_tree_view_column_new_with_area (GtkCellArea *area) * } * ]| * - * Return value: A newly created #GtkTreeViewColumn. + * Returns: A newly created #GtkTreeViewColumn. **/ GtkTreeViewColumn * gtk_tree_view_column_new_with_attributes (const gchar *title, @@ -1887,7 +1887,7 @@ gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column, * * Returns the spacing of @tree_column. * - * Return value: the spacing of @tree_column. + * Returns: the spacing of @tree_column. **/ gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column) @@ -1946,7 +1946,7 @@ gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column, * * Returns %TRUE if @tree_column is visible. * - * Return value: whether the column is visible or not. If it is visible, then + * Returns: whether the column is visible or not. If it is visible, then * the tree will show the column. **/ gboolean @@ -1997,7 +1997,7 @@ gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column, * * Returns %TRUE if the @tree_column can be resized by the end user. * - * Return value: %TRUE, if the @tree_column can be resized. + * Returns: %TRUE, if the @tree_column can be resized. **/ gboolean gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column) @@ -2044,7 +2044,7 @@ gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column, * * Returns the current type of @tree_column. * - * Return value: The type of @tree_column. + * Returns: The type of @tree_column. **/ GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column) @@ -2060,7 +2060,7 @@ gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column) * * Returns the current size of @tree_column in pixels. * - * Return value: The current width of @tree_column. + * Returns: The current width of @tree_column. **/ gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column) @@ -2076,7 +2076,7 @@ gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column) * * Returns the current X offset of @tree_column in pixels. * - * Return value: The current X offset of @tree_column. + * Returns: The current X offset of @tree_column. * * Since: 3.2 */ @@ -2223,7 +2223,7 @@ gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column, * Gets the fixed width of the column. This may not be the actual displayed * width of the column; for that, use gtk_tree_view_column_get_width(). * - * Return value: The fixed width of the column. + * Returns: The fixed width of the column. **/ gint gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column) @@ -2285,7 +2285,7 @@ gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column, * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum * width is set. * - * Return value: The minimum width of the @tree_column. + * Returns: The minimum width of the @tree_column. **/ gint gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column) @@ -2349,7 +2349,7 @@ gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column, * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum * width is set. * - * Return value: The maximum width of the @tree_column. + * Returns: The maximum width of the @tree_column. **/ gint gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column) @@ -2414,7 +2414,7 @@ gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column, * * Returns the title of the widget. * - * Return value: the title of the column. This string should not be + * Returns: the title of the column. This string should not be * modified or freed. **/ const gchar * @@ -2471,7 +2471,7 @@ gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column, * * Returns %TRUE if the column expands to fill available space. * - * Return value: %TRUE if the column expands to fill available space. + * Returns: %TRUE if the column expands to fill available space. * * Since: 2.4 **/ @@ -2516,7 +2516,7 @@ gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column, * * Returns %TRUE if the user can click on the header for the column. * - * Return value: %TRUE if user can click the column header. + * Returns: %TRUE if user can click the column header. **/ gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column) @@ -2563,7 +2563,7 @@ gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column, * Returns the #GtkWidget in the button on the column header. * If a custom widget has not been set then %NULL is returned. * - * Return value: (transfer none): The #GtkWidget in the column + * Returns: (transfer none): The #GtkWidget in the column * header, or %NULL **/ GtkWidget * @@ -2610,7 +2610,7 @@ gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column, * Returns the current x alignment of @tree_column. This value can range * between 0.0 and 1.0. * - * Return value: The current alignent of @tree_column. + * Returns: The current alignent of @tree_column. **/ gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column) @@ -2655,7 +2655,7 @@ gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column, * * Returns %TRUE if the @tree_column can be reordered by the user. * - * Return value: %TRUE if the @tree_column can be reordered by the user. + * Returns: %TRUE if the @tree_column can be reordered by the user. **/ gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column) @@ -2734,7 +2734,7 @@ gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column, * column is selected for sorting. * See gtk_tree_view_column_set_sort_column_id(). * - * Return value: the current @sort_column_id for this column, or -1 if + * Returns: the current @sort_column_id for this column, or -1 if * this column can’t be used for sorting. **/ gint @@ -2778,7 +2778,7 @@ gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column, * * Gets the value set by gtk_tree_view_column_set_sort_indicator(). * - * Return value: whether the sort indicator arrow is displayed + * Returns: whether the sort indicator arrow is displayed **/ gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column) @@ -2825,7 +2825,7 @@ gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column, * * Gets the value set by gtk_tree_view_column_set_sort_order(). * - * Return value: the sort order the sort indicator is indicating + * Returns: the sort order the sort indicator is indicating **/ GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column) @@ -2985,7 +2985,7 @@ _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column, * For this to be meaningful, you must first initialize the cells with * gtk_tree_view_column_cell_set_cell_data() * - * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible + * Returns: %TRUE, if any of the cells packed into the @tree_column are currently visible **/ gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column) @@ -3079,7 +3079,7 @@ _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column) * cell is not found in the column, @start_pos and @width are not changed and * %FALSE is returned. * - * Return value: %TRUE if @cell belongs to @tree_column. + * Returns: %TRUE if @cell belongs to @tree_column. */ gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column, @@ -3144,7 +3144,7 @@ gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column) * If @column is currently not inserted in any tree view, %NULL is * returned. * - * Return value: (transfer none): The tree view wherein @column has + * Returns: (transfer none): The tree view wherein @column has * been inserted if any, %NULL otherwise. * * Since: 2.12 @@ -3163,7 +3163,7 @@ gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column) * * Returns the button used in the treeview column header * - * Return value: (transfer none): The button for the column header. + * Returns: (transfer none): The button for the column header. * * Since: 3.0 */ diff --git a/gtk/gtkversion.h.in b/gtk/gtkversion.h.in index cfebc2b80c..b6b5337223 100644 --- a/gtk/gtkversion.h.in +++ b/gtk/gtkversion.h.in @@ -93,7 +93,7 @@ * Returns %TRUE if the version of the GTK+ header files * is the same as or newer than the passed-in version. * - * Return value: %TRUE if GTK+ headers are new enough + * Returns: %TRUE if GTK+ headers are new enough */ #define GTK_CHECK_VERSION(major,minor,micro) \ (GTK_MAJOR_VERSION > (major) || \ diff --git a/gtk/gtkviewport.c b/gtk/gtkviewport.c index 51b6e3a216..e129610bd3 100644 --- a/gtk/gtkviewport.c +++ b/gtk/gtkviewport.c @@ -370,7 +370,7 @@ viewport_get_view_allocation (GtkViewport *viewport, * * Returns the horizontal adjustment of the viewport. * - * Return value: (transfer none): the horizontal adjustment of @viewport. + * Returns: (transfer none): the horizontal adjustment of @viewport. * * Deprecated: 3.0: Use gtk_scrollable_get_hadjustment() **/ @@ -388,7 +388,7 @@ gtk_viewport_get_hadjustment (GtkViewport *viewport) * * Returns the vertical adjustment of the viewport. * - * Return value: (transfer none): the vertical adjustment of @viewport. + * Returns: (transfer none): the vertical adjustment of @viewport. * * Deprecated: 3.0: Use gtk_scrollable_get_vadjustment() **/ @@ -613,7 +613,7 @@ gtk_viewport_set_shadow_type (GtkViewport *viewport, * Gets the shadow type of the #GtkViewport. See * gtk_viewport_set_shadow_type(). * - * Return value: the shadow type + * Returns: the shadow type **/ GtkShadowType gtk_viewport_get_shadow_type (GtkViewport *viewport) @@ -629,7 +629,7 @@ gtk_viewport_get_shadow_type (GtkViewport *viewport) * * Gets the bin window of the #GtkViewport. * - * Return value: (transfer none): a #GdkWindow + * Returns: (transfer none): a #GdkWindow * * Since: 2.20 **/ @@ -647,7 +647,7 @@ gtk_viewport_get_bin_window (GtkViewport *viewport) * * Gets the view window of the #GtkViewport. * - * Return value: (transfer none): a #GdkWindow + * Returns: (transfer none): a #GdkWindow * * Since: 2.22 **/ diff --git a/gtk/gtkvolumebutton.c b/gtk/gtkvolumebutton.c index 4f2d613140..ada64ae4e7 100644 --- a/gtk/gtkvolumebutton.c +++ b/gtk/gtkvolumebutton.c @@ -184,7 +184,7 @@ gtk_volume_button_init (GtkVolumeButton *button) * a stepping of 0.02. Volume values can be obtained and modified using * the functions from #GtkScaleButton. * - * Return value: a new #GtkVolumeButton + * Returns: a new #GtkVolumeButton * * Since: 2.12 */ diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c index b3b0a3bd8e..52cf13f387 100644 --- a/gtk/gtkwidget.c +++ b/gtk/gtkwidget.c @@ -2898,7 +2898,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS * been already handled (not showing the default "drag operation failed" * animation), otherwise it returns %FALSE. * - * Return value: %TRUE if the failed drag operation has been already handled. + * Returns: %TRUE if the failed drag operation has been already handled. * * Since: 2.12 */ @@ -4145,7 +4145,7 @@ gtk_widget_thaw_child_notify (GtkWidget *widget) * g_object_new(), but returns a widget so you don’t have to * cast the object yourself. * - * Return value: a new #GtkWidget of type @widget_type + * Returns: a new #GtkWidget of type @widget_type **/ GtkWidget* gtk_widget_new (GType type, @@ -4520,7 +4520,7 @@ gtk_widget_real_hide (GtkWidget *widget) * the window. By default, GTK+ destroys windows when ::delete-event * is received. * - * Return value: %TRUE + * Returns: %TRUE **/ gboolean gtk_widget_hide_on_delete (GtkWidget *widget) @@ -5304,7 +5304,7 @@ gtk_widget_queue_resize_no_redraw (GtkWidget *widget) * * Unrealized widgets do not have a frame clock. * - * Return value: (transfer none): a #GdkFrameClock (or #NULL if widget is unrealized) + * Returns: (transfer none): a #GdkFrameClock (or #NULL if widget is unrealized) * * Since: 3.8 */ @@ -5689,7 +5689,7 @@ gtk_widget_size_allocate (GtkWidget *widget, * Find the common ancestor of @widget_a and @widget_b that * is closest to the two widgets. * - * Return value: the closest common ancestor of @widget_a and + * Returns: the closest common ancestor of @widget_a and * @widget_b or %NULL if @widget_a and @widget_b do not * share a common ancestor. **/ @@ -5754,7 +5754,7 @@ gtk_widget_common_ancestor (GtkWidget *widget_a, * operation, both widgets must be realized, and must share a common * toplevel. * - * Return value: %FALSE if either widget was not realized, or there + * Returns: %FALSE if either widget was not realized, or there * was no common ancestor. In this case, nothing is stored in * *@dest_x and *@dest_y. Otherwise %TRUE. **/ @@ -6010,7 +6010,7 @@ gtk_widget_real_can_activate_accel (GtkWidget *widget, * that the widget must be sensitive, and the widget and all * its ancestors mapped. * - * Return value: %TRUE if the accelerator can be activated. + * Returns: %TRUE if the accelerator can be activated. * * Since: 2.4 **/ @@ -6219,7 +6219,7 @@ gtk_widget_remove_accelerator (GtkWidget *widget, * #GtkAccelGroup of a closure which can be found out with * gtk_accel_group_from_accel_closure(). * - * Return value: (transfer container) (element-type GClosure): + * Returns: (transfer container) (element-type GClosure): * a newly allocated #GList of closures */ GList* @@ -6863,7 +6863,7 @@ gtk_widget_real_touch_event (GtkWidget *widget, * use gdk_window_invalidate_rect() to invalidate a region of the * window. * - * Return value: return from the event signal emission (%TRUE if + * Returns: return from the event signal emission (%TRUE if * the event was handled) **/ gboolean @@ -7027,7 +7027,7 @@ gtk_cairo_transform_to_window (cairo_t *cr, * To cause the redraw to be done immediately, follow that call * with a call to gdk_window_process_updates(). * - * Return value: return from the event signal emission (%TRUE if + * Returns: return from the event signal emission (%TRUE if * the event was handled) **/ gint @@ -7240,7 +7240,7 @@ gtk_widget_event_internal (GtkWidget *widget, * press Enter on a widget during key navigation. If @widget isn't * activatable, the function returns %FALSE. * - * Return value: %TRUE if the widget was activatable + * Returns: %TRUE if the widget was activatable **/ gboolean gtk_widget_activate (GtkWidget *widget) @@ -7393,7 +7393,7 @@ gtk_widget_reparent (GtkWidget *widget, * an intersection. @intersection may be %NULL if you’re only * interested in whether there was an intersection. * - * Return value: %TRUE if there was an intersection + * Returns: %TRUE if there was an intersection **/ gboolean gtk_widget_intersect (GtkWidget *widget, @@ -7768,7 +7768,7 @@ gtk_widget_set_can_focus (GtkWidget *widget, * Determines whether @widget can own the input focus. See * gtk_widget_set_can_focus(). * - * Return value: %TRUE if @widget can own the input focus, %FALSE otherwise + * Returns: %TRUE if @widget can own the input focus, %FALSE otherwise * * Since: 2.18 **/ @@ -7788,7 +7788,7 @@ gtk_widget_get_can_focus (GtkWidget *widget) * gtk_widget_is_focus() for the difference between having the global * input focus, and only having the focus within a toplevel. * - * Return value: %TRUE if the widget has the global input focus. + * Returns: %TRUE if the widget has the global input focus. * * Since: 2.18 **/ @@ -7814,7 +7814,7 @@ gtk_widget_has_focus (GtkWidget *widget) * To find out if the widget has the global input focus, use * gtk_widget_has_focus(). * - * Return value: %TRUE if the widget should display a “focus rectangle” + * Returns: %TRUE if the widget should display a “focus rectangle” * * Since: 3.2 */ @@ -7851,7 +7851,7 @@ gtk_widget_has_visible_focus (GtkWidget *widget) * necessarily set; #GtkWidget:has-focus will only be set if the * toplevel widget additionally has the global input focus.) * - * Return value: %TRUE if the widget is the focus widget. + * Returns: %TRUE if the widget is the focus widget. **/ gboolean gtk_widget_is_focus (GtkWidget *widget) @@ -7901,7 +7901,7 @@ gtk_widget_set_can_default (GtkWidget *widget, * Determines whether @widget can be a default widget. See * gtk_widget_set_can_default(). * - * Return value: %TRUE if @widget can be a default widget, %FALSE otherwise + * Returns: %TRUE if @widget can be a default widget, %FALSE otherwise * * Since: 2.18 **/ @@ -7920,7 +7920,7 @@ gtk_widget_get_can_default (GtkWidget *widget) * Determines whether @widget is the current default widget within its * toplevel. See gtk_widget_set_can_default(). * - * Return value: %TRUE if @widget is the current default widget within + * Returns: %TRUE if @widget is the current default widget within * its toplevel, %FALSE otherwise * * Since: 2.18 @@ -8017,7 +8017,7 @@ gtk_widget_set_receives_default (GtkWidget *widget, * * See gtk_widget_set_receives_default(). * - * Return value: %TRUE if @widget acts as the default widget when focussed, + * Returns: %TRUE if @widget acts as the default widget when focussed, * %FALSE otherwise * * Since: 2.18 @@ -8039,7 +8039,7 @@ gtk_widget_get_receives_default (GtkWidget *widget) * * See also gtk_grab_add(). * - * Return value: %TRUE if the widget is in the grab_widgets stack + * Returns: %TRUE if the widget is in the grab_widgets stack * * Since: 2.18 **/ @@ -8152,7 +8152,7 @@ gtk_widget_set_name (GtkWidget *widget, * Retrieves the name of a widget. See gtk_widget_set_name() for the * significance of widget names. * - * Return value: name of the widget. This string is owned by GTK+ and + * Returns: name of the widget. This string is owned by GTK+ and * should not be modified or freed **/ const gchar* @@ -8440,7 +8440,7 @@ _gtk_widget_set_visible_flag (GtkWidget *widget, * * See gtk_widget_set_visible(). * - * Return value: %TRUE if the widget is visible + * Returns: %TRUE if the widget is visible * * Since: 2.18 **/ @@ -8463,7 +8463,7 @@ gtk_widget_get_visible (GtkWidget *widget) * * See also gtk_widget_get_visible() and gtk_widget_set_visible() * - * Return value: %TRUE if the widget and all its parents are visible + * Returns: %TRUE if the widget and all its parents are visible * * Since: 3.8 **/ @@ -8519,7 +8519,7 @@ gtk_widget_set_has_window (GtkWidget *widget, * Determines whether @widget has a #GdkWindow of its own. See * gtk_widget_set_has_window(). * - * Return value: %TRUE if @widget has a window, %FALSE otherwise + * Returns: %TRUE if @widget has a window, %FALSE otherwise * * Since: 2.18 **/ @@ -8541,7 +8541,7 @@ gtk_widget_get_has_window (GtkWidget *widget) * #GtkPlugs) are toplevel widgets. Toplevel widgets have no parent * widget. * - * Return value: %TRUE if @widget is a toplevel, %FALSE otherwise + * Returns: %TRUE if @widget is a toplevel, %FALSE otherwise * * Since: 2.18 **/ @@ -8567,7 +8567,7 @@ _gtk_widget_set_is_toplevel (GtkWidget *widget, * Determines whether @widget can be drawn to. A widget can be drawn * to if it is mapped and visible. * - * Return value: %TRUE if @widget is drawable, %FALSE otherwise + * Returns: %TRUE if @widget is drawable, %FALSE otherwise * * Since: 2.18 **/ @@ -8586,7 +8586,7 @@ gtk_widget_is_drawable (GtkWidget *widget) * * Determines whether @widget is realized. * - * Return value: %TRUE if @widget is realized, %FALSE otherwise + * Returns: %TRUE if @widget is realized, %FALSE otherwise * * Since: 2.20 **/ @@ -8625,7 +8625,7 @@ gtk_widget_set_realized (GtkWidget *widget, * * Whether the widget is mapped. * - * Return value: %TRUE if the widget is mapped, %FALSE otherwise. + * Returns: %TRUE if the widget is mapped, %FALSE otherwise. * * Since: 2.20 */ @@ -8703,7 +8703,7 @@ gtk_widget_set_app_paintable (GtkWidget *widget, * * See gtk_widget_set_app_paintable() * - * Return value: %TRUE if the widget is app paintable + * Returns: %TRUE if the widget is app paintable * * Since: 2.18 **/ @@ -8766,7 +8766,7 @@ gtk_widget_set_double_buffered (GtkWidget *widget, * * See gtk_widget_set_double_buffered() * - * Return value: %TRUE if the widget is double buffered + * Returns: %TRUE if the widget is double buffered * * Since: 2.18 **/ @@ -9009,7 +9009,7 @@ gtk_widget_set_parent (GtkWidget *widget, * * Returns the parent container of @widget. * - * Return value: (transfer none): the parent container of @widget, or %NULL + * Returns: (transfer none): the parent container of @widget, or %NULL **/ GtkWidget * gtk_widget_get_parent (GtkWidget *widget) @@ -9373,7 +9373,7 @@ gtk_widget_propagate_screen_changed_recurse (GtkWidget *widget, * in the future if used on a widget that has a composited * window in its hierarchy (as set by gdk_window_set_composited()). * - * Return value: %TRUE if the widget can rely on its alpha + * Returns: %TRUE if the widget can rely on its alpha * channel being drawn correctly. * * Since: 2.10 @@ -9669,7 +9669,7 @@ gtk_widget_peek_pango_context (GtkWidget *widget) * match any changes to the widget’s attributes. This can be tracked * by using the #GtkWidget::screen-changed signal on the widget. * - * Return value: (transfer none): the #PangoContext for the widget. + * Returns: (transfer none): the #PangoContext for the widget. **/ PangoContext * gtk_widget_get_pango_context (GtkWidget *widget) @@ -9742,7 +9742,7 @@ gtk_widget_update_pango_context (GtkWidget *widget) * font description, and base direction for drawing text for * this widget. See also gtk_widget_get_pango_context(). * - * Return value: (transfer full): the new #PangoContext + * Returns: (transfer full): the new #PangoContext **/ PangoContext * gtk_widget_create_pango_context (GtkWidget *widget) @@ -9783,7 +9783,7 @@ gtk_widget_create_pango_context (GtkWidget *widget) * This can be tracked by using the #GtkWidget::screen-changed signal * on the widget. * - * Return value: (transfer full): the new #PangoLayout + * Returns: (transfer full): the new #PangoLayout **/ PangoLayout * gtk_widget_create_pango_layout (GtkWidget *widget, @@ -9821,7 +9821,7 @@ gtk_widget_create_pango_layout (GtkWidget *widget, * the application and should not be modified. The pixbuf should be freed * after use with g_object_unref(). * - * Return value: (transfer full): a new pixbuf, or %NULL if the + * Returns: (transfer full): a new pixbuf, or %NULL if the * stock ID wasn’t known * * Since: 3.0 @@ -10001,7 +10001,7 @@ gtk_widget_set_child_visible (GtkWidget *widget, * This function is only useful for container implementations and * never should be called by an application. * - * Return value: %TRUE if the widget is mapped with the parent. + * Returns: %TRUE if the widget is mapped with the parent. **/ gboolean gtk_widget_get_child_visible (GtkWidget *widget) @@ -10042,7 +10042,7 @@ gtk_widget_get_screen_unchecked (GtkWidget *widget) * resources when a widget has been realized, and you should * free those resources when the widget is unrealized. * - * Return value: (transfer none): the #GdkScreen for the toplevel for this widget. + * Returns: (transfer none): the #GdkScreen for the toplevel for this widget. * * Since: 2.2 **/ @@ -10079,7 +10079,7 @@ gtk_widget_get_screen (GtkWidget *widget) * screen, and all widgets added into a hierarchy with a toplevel * window at the top. * - * Return value: %TRUE if there is a #GdkScreen associcated + * Returns: %TRUE if there is a #GdkScreen associcated * with the widget. * * Since: 2.2 @@ -10165,7 +10165,7 @@ gtk_widget_get_scale_factor (GtkWidget *widget) * resources when a widget has been realized, and you should * free those resources when the widget is unrealized. * - * Return value: (transfer none): the #GdkDisplay for the toplevel for this widget. + * Returns: (transfer none): the #GdkDisplay for the toplevel for this widget. * * Since: 2.2 **/ @@ -10190,7 +10190,7 @@ gtk_widget_get_display (GtkWidget *widget) * create display specific resources when a widget has been realized, * and you should free those resources when the widget is unrealized. * - * Return value: (transfer none): the #GdkWindow root window for the toplevel for this widget. + * Returns: (transfer none): the #GdkWindow root window for the toplevel for this widget. * * Since: 2.2 * @@ -10229,7 +10229,7 @@ gtk_widget_get_root_window (GtkWidget *widget) * call gtk_widget_grab_focus() to place the focus accordingly; * if returning %FALSE, they don’t modify the current focus location. * - * Return value: %TRUE if focus ended up inside @widget + * Returns: %TRUE if focus ended up inside @widget **/ gboolean gtk_widget_child_focus (GtkWidget *widget, @@ -10291,7 +10291,7 @@ gtk_widget_child_focus (GtkWidget *widget, * entire row with the cursor keys, as e.g. known from user interfaces * that require entering license keys. * - * Return value: %TRUE if stopping keyboard navigation is fine, %FALSE + * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE * if the emitting widget should try to handle the keyboard * navigation attempt in its parent container(s). * @@ -10634,7 +10634,7 @@ gtk_widget_set_device_enabled (GtkWidget *widget, * Returns whether @device can interact with @widget and its * children. See gtk_widget_set_device_enabled(). * - * Return value: %TRUE is @device is enabled for @widget + * Returns: %TRUE is @device is enabled for @widget * * Since: 3.0 */ @@ -10800,7 +10800,7 @@ gtk_widget_add_device_events (GtkWidget *widget, * } * ]| * - * Return value: (transfer none): the topmost ancestor of @widget, or @widget itself + * Returns: (transfer none): the topmost ancestor of @widget, or @widget itself * if there’s no ancestor. **/ GtkWidget* @@ -10829,7 +10829,7 @@ gtk_widget_get_toplevel (GtkWidget *widget) * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor() * considers @widget to be an ancestor of itself. * - * Return value: (transfer none): the ancestor widget, or %NULL if not found + * Returns: (transfer none): the ancestor widget, or %NULL if not found **/ GtkWidget* gtk_widget_get_ancestor (GtkWidget *widget, @@ -10882,7 +10882,7 @@ gtk_widget_set_visual (GtkWidget *widget, * * Gets the visual that will be used to render @widget. * - * Return value: (transfer none): the visual for @widget + * Returns: (transfer none): the visual for @widget **/ GdkVisual* gtk_widget_get_visual (GtkWidget *widget) @@ -10925,7 +10925,7 @@ gtk_widget_get_visual (GtkWidget *widget) * is attached to a toplevel, since the settings object is specific * to a particular #GdkScreen. * - * Return value: (transfer none): the relevant #GtkSettings object + * Returns: (transfer none): the relevant #GtkSettings object */ GtkSettings* gtk_widget_get_settings (GtkWidget *widget) @@ -10943,7 +10943,7 @@ gtk_widget_get_settings (GtkWidget *widget) * from the #GdkEventMask enumeration). These are the events that the widget * will receive. * - * Return value: event mask for @widget + * Returns: event mask for @widget **/ gint gtk_widget_get_events (GtkWidget *widget) @@ -11038,7 +11038,7 @@ gtk_widget_get_pointer (GtkWidget *widget, * Determines whether @widget is somewhere inside @ancestor, possibly with * intermediate containers. * - * Return value: %TRUE if @ancestor contains @widget as a child, + * Returns: %TRUE if @ancestor contains @widget as a child, * grandchild, great grandchild, etc. **/ gboolean @@ -11226,7 +11226,7 @@ gtk_widget_set_direction (GtkWidget *widget, * Gets the reading direction for a particular widget. See * gtk_widget_set_direction(). * - * Return value: the reading direction for the widget. + * Returns: the reading direction for the widget. **/ GtkTextDirection gtk_widget_get_direction (GtkWidget *widget) @@ -11298,7 +11298,7 @@ gtk_widget_set_default_direction (GtkTextDirection dir) * Obtains the current default reading direction. See * gtk_widget_set_default_direction(). * - * Return value: the current default direction. + * Returns: the current default direction. **/ GtkTextDirection gtk_widget_get_default_direction (void) @@ -11766,7 +11766,7 @@ gtk_widget_real_adjust_baseline_request (GtkWidget *widget, * Returns the address of the widget’s request cache (strictly for * internal use in gtksizerequest.c) * - * Return value: the address of @widget’s size request cache. + * Returns: the address of @widget’s size request cache. **/ gpointer _gtk_widget_peek_request_cache (GtkWidget *widget) @@ -11825,7 +11825,7 @@ _gtk_widget_set_device_window (GtkWidget *widget, * @widget: a #GtkWidget * @device: a #GdkDevice * - * Return value: the device window set on @widget, or %NULL + * Returns: the device window set on @widget, or %NULL */ GdkWindow * _gtk_widget_get_device_window (GtkWidget *widget, @@ -12223,7 +12223,7 @@ static const GtkWidgetAuxInfo default_aux_info = { * * Get the #GtkWidgetAuxInfo-struct for the widget. * - * Return value: the #GtkWidgetAuxInfo-struct for the widget, or + * Returns: the #GtkWidgetAuxInfo-struct for the widget, or * %NULL if @create is %FALSE and one doesn’t already exist. */ static GtkWidgetAuxInfo * @@ -12976,7 +12976,7 @@ gtk_widget_queue_compute_expand (GtkWidget *widget) * set on the widget itself, or, if none has been explicitly set, * the widget may expand if some of its children do. * - * Return value: whether widget tree rooted here should be expanded + * Returns: whether widget tree rooted here should be expanded */ gboolean gtk_widget_compute_expand (GtkWidget *widget, @@ -13106,7 +13106,7 @@ gtk_widget_set_expand_set (GtkWidget *widget, * than computing whether the entire widget tree rooted at this widget * wants to expand. * - * Return value: whether hexpand flag is set + * Returns: whether hexpand flag is set */ gboolean gtk_widget_get_hexpand (GtkWidget *widget) @@ -13171,7 +13171,7 @@ gtk_widget_set_hexpand (GtkWidget *widget, * There are few reasons to use this function, but it’s here * for completeness and consistency. * - * Return value: whether hexpand has been explicitly set + * Returns: whether hexpand has been explicitly set */ gboolean gtk_widget_get_hexpand_set (GtkWidget *widget) @@ -13221,7 +13221,7 @@ gtk_widget_set_hexpand_set (GtkWidget *widget, * * See gtk_widget_get_hexpand() for more detail. * - * Return value: whether vexpand flag is set + * Returns: whether vexpand flag is set */ gboolean gtk_widget_get_vexpand (GtkWidget *widget) @@ -13259,7 +13259,7 @@ gtk_widget_set_vexpand (GtkWidget *widget, * * See gtk_widget_get_hexpand_set() for more detail. * - * Return value: whether vexpand has been explicitly set + * Returns: whether vexpand has been explicitly set */ gboolean gtk_widget_get_vexpand_set (GtkWidget *widget) @@ -14417,7 +14417,7 @@ gtk_widget_set_margin_bottom (GtkWidget *widget, * associated with it, so must be attached to a toplevel * window. * - * Return value: (transfer none): the appropriate clipboard object. If no + * Returns: (transfer none): the appropriate clipboard object. If no * clipboard already exists, a new one will * be created. Once a clipboard object has * been created, it is persistent for all time. @@ -14449,7 +14449,7 @@ gtk_widget_get_clipboard (GtkWidget *widget, GdkAtom selection) * (GFunc)g_object_ref, NULL)` first, and then unref all the * widgets afterwards. - * Return value: (element-type GtkWidget) (transfer container): the list of + * Returns: (element-type GtkWidget) (transfer container): the list of * mnemonic labels; free this list * with g_list_free() when you are done with it. * @@ -14537,7 +14537,7 @@ gtk_widget_remove_mnemonic_label (GtkWidget *widget, * which determines whether calls to gtk_widget_show_all() * will affect this widget. * - * Return value: the current value of the “no-show-all” property. + * Returns: the current value of the “no-show-all” property. * * Since: 2.4 **/ @@ -14664,7 +14664,7 @@ gtk_widget_set_tooltip_window (GtkWidget *widget, * GtkWindow created by default, or the custom tooltip window set * using gtk_widget_set_tooltip_window(). * - * Return value: (transfer none): The #GtkWindow of the current tooltip. + * Returns: (transfer none): The #GtkWindow of the current tooltip. * * Since: 2.12 */ @@ -14750,7 +14750,7 @@ gtk_widget_set_tooltip_text (GtkWidget *widget, * * Gets the contents of the tooltip for @widget. * - * Return value: the tooltip text, or %NULL. You should free the + * Returns: the tooltip text, or %NULL. You should free the * returned string with g_free() when done. * * Since: 2.12 @@ -14798,7 +14798,7 @@ gtk_widget_set_tooltip_markup (GtkWidget *widget, * * Gets the contents of the tooltip for @widget. * - * Return value: the tooltip text, or %NULL. You should free the + * Returns: the tooltip text, or %NULL. You should free the * returned string with g_free() when done. * * Since: 2.12 @@ -14841,7 +14841,7 @@ gtk_widget_set_has_tooltip (GtkWidget *widget, * Returns the current value of the has-tooltip property. See * #GtkWidget:has-tooltip for more information. * - * Return value: current value of has-tooltip on @widget. + * Returns: current value of has-tooltip on @widget. * * Since: 2.12 */ @@ -15122,7 +15122,7 @@ gtk_widget_unregister_window (GtkWidget *widget, * * Returns the widget’s window if it is realized, %NULL otherwise * - * Return value: (transfer none): @widget’s window. + * Returns: (transfer none): @widget’s window. * * Since: 2.14 */ @@ -15273,7 +15273,7 @@ gtk_widget_set_opacity (GtkWidget *widget, * Fetches the requested opacity for this widget. See * gtk_widget_set_opacity(). * - * Return value: the requested opacity for this widget. + * Returns: the requested opacity for this widget. * * Since: 3.8 **/ @@ -15326,7 +15326,7 @@ _gtk_widget_set_has_focus (GtkWidget *widget, * gdk_event_free (event); * ]| * - * Return value: the return value from the event signal emission: %TRUE + * Returns: the return value from the event signal emission: %TRUE * if the event was handled, and %FALSE otherwise * * Since: 2.20 diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index a12e8d0c8d..64ab2b7b54 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -1845,7 +1845,7 @@ gtk_window_buildable_custom_finished (GtkBuildable *buildable, * * To delete a #GtkWindow, call gtk_window_destroy(). * - * Return value: a new #GtkWindow. + * Returns: a new #GtkWindow. **/ GtkWidget* gtk_window_new (GtkWindowType type) @@ -1923,7 +1923,7 @@ gtk_window_set_title (GtkWindow *window, * * Retrieves the title of the window. See gtk_window_set_title(). * - * Return value: the title of the window, or %NULL if none has + * Returns: the title of the window, or %NULL if none has * been set explicitly. The returned string is owned by the widget * and must not be modified or freed. **/ @@ -2086,7 +2086,7 @@ gtk_window_set_startup_id (GtkWindow *window, * Returns the role of the window. See gtk_window_set_role() for * further explanation. * - * Return value: the role of the window if set, or %NULL. The + * Returns: the role of the window if set, or %NULL. The * returned is owned by the widget and must not be modified * or freed. **/ @@ -2434,7 +2434,7 @@ gtk_window_set_mnemonic_modifier (GtkWindow *window, * Returns the mnemonic modifier for this window. See * gtk_window_set_mnemonic_modifier(). * - * Return value: the modifier mask used to activate + * Returns: the modifier mask used to activate * mnemonics on this window. **/ GdkModifierType @@ -2491,7 +2491,7 @@ gtk_window_set_position (GtkWindow *window, * * Activates the current focused widget within the window. * - * Return value: %TRUE if a widget got activated. + * Returns: %TRUE if a widget got activated. **/ gboolean gtk_window_activate_focus (GtkWindow *window) @@ -2518,7 +2518,7 @@ gtk_window_activate_focus (GtkWindow *window) * is not focused then `gtk_widget_has_focus (widget)` will * not be %TRUE for the widget. * - * Return value: (transfer none): the currently focused widget, or %NULL if there is none. + * Returns: (transfer none): the currently focused widget, or %NULL if there is none. **/ GtkWidget * gtk_window_get_focus (GtkWindow *window) @@ -2537,7 +2537,7 @@ gtk_window_get_focus (GtkWindow *window) * (see gtk_widget_set_receives_default()), in which case the * focused widget is activated. * - * Return value: %TRUE if a widget got activated. + * Returns: %TRUE if a widget got activated. **/ gboolean gtk_window_activate_default (GtkWindow *window) @@ -2615,7 +2615,7 @@ gtk_window_set_modal (GtkWindow *window, * * Returns whether the window is modal. See gtk_window_set_modal(). * - * Return value: %TRUE if the window is set to be modal and + * Returns: %TRUE if the window is set to be modal and * establishes a grab when shown **/ gboolean @@ -2636,7 +2636,7 @@ gtk_window_get_modal (GtkWindow *window) * `g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and * then unref all the widgets afterwards. * - * Return value: (element-type GtkWidget) (transfer container): list of toplevel widgets + * Returns: (element-type GtkWidget) (transfer container): list of toplevel widgets **/ GList* gtk_window_list_toplevels (void) @@ -2862,7 +2862,7 @@ gtk_window_set_transient_for (GtkWindow *window, * Fetches the transient parent for this window. See * gtk_window_set_transient_for(). * - * Return value: (transfer none): the transient parent for this window, or %NULL + * Returns: (transfer none): the transient parent for this window, or %NULL * if no transient parent has been set. **/ GtkWindow * @@ -2936,7 +2936,7 @@ gtk_window_set_attached_to (GtkWindow *window, * Fetches the attach widget for this window. See * gtk_window_set_attached_to(). * - * Return value: (transfer none): the widget where the window is attached, + * Returns: (transfer none): the widget where the window is attached, * or %NULL if the window is not attached to any widget. * * Since: 3.4 @@ -2981,7 +2981,7 @@ gtk_window_set_opacity (GtkWindow *window, * Fetches the requested opacity for this window. See * gtk_window_set_opacity(). * - * Return value: the requested opacity for this window. + * Returns: the requested opacity for this window. * * Since: 2.12 * Deprecated: 3.8: Use gtk_widget_get_opacity instead. @@ -3000,7 +3000,7 @@ gtk_window_get_opacity (GtkWindow *window) * * Gets the #GtkApplication associated with the window (if any). * - * Return value: (transfer none): a #GtkApplication, or %NULL + * Returns: (transfer none): a #GtkApplication, or %NULL * * Since: 3.0 **/ @@ -3113,7 +3113,7 @@ gtk_window_set_type_hint (GtkWindow *window, * * Gets the type hint for this window. See gtk_window_set_type_hint(). * - * Return value: the type hint for @window. + * Returns: the type hint for @window. **/ GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window) @@ -3161,7 +3161,7 @@ gtk_window_set_skip_taskbar_hint (GtkWindow *window, * * Gets the value set by gtk_window_set_skip_taskbar_hint() * - * Return value: %TRUE if window shouldn’t be in taskbar + * Returns: %TRUE if window shouldn’t be in taskbar * * Since: 2.2 **/ @@ -3214,7 +3214,7 @@ gtk_window_set_skip_pager_hint (GtkWindow *window, * * Gets the value set by gtk_window_set_skip_pager_hint(). * - * Return value: %TRUE if window shouldn’t be in pager + * Returns: %TRUE if window shouldn’t be in pager * * Since: 2.2 **/ @@ -3264,7 +3264,7 @@ gtk_window_set_urgency_hint (GtkWindow *window, * * Gets the value set by gtk_window_set_urgency_hint() * - * Return value: %TRUE if window is urgent + * Returns: %TRUE if window is urgent * * Since: 2.8 **/ @@ -3314,7 +3314,7 @@ gtk_window_set_accept_focus (GtkWindow *window, * * Gets the value set by gtk_window_set_accept_focus(). * - * Return value: %TRUE if window should receive the input focus + * Returns: %TRUE if window should receive the input focus * * Since: 2.4 **/ @@ -3365,7 +3365,7 @@ gtk_window_set_focus_on_map (GtkWindow *window, * * Gets the value set by gtk_window_set_focus_on_map(). * - * Return value: %TRUE if window should receive the input focus when + * Returns: %TRUE if window should receive the input focus when * mapped. * * Since: 2.6 @@ -3422,7 +3422,7 @@ gtk_window_set_destroy_with_parent (GtkWindow *window, * Returns whether the window will be destroyed with its transient parent. See * gtk_window_set_destroy_with_parent (). * - * Return value: %TRUE if the window will be destroyed with its transient parent. + * Returns: %TRUE if the window will be destroyed with its transient parent. **/ gboolean gtk_window_get_destroy_with_parent (GtkWindow *window) @@ -3478,7 +3478,7 @@ gtk_window_set_hide_titlebar_when_maximized (GtkWindow *window, * Returns whether the window has requested to have its titlebar hidden * when maximized. See gtk_window_set_hide_titlebar_when_maximized (). * - * Return value: %TRUE if the window has requested to have its titlebar + * Returns: %TRUE if the window has requested to have its titlebar * hidden when maximized * * Since: 3.4 @@ -3811,7 +3811,7 @@ gtk_window_set_decorated (GtkWindow *window, * Returns whether the window has been set to have decorations * such as a title bar via gtk_window_set_decorated(). * - * Return value: %TRUE if the window has been set to have decorations + * Returns: %TRUE if the window has been set to have decorations **/ gboolean gtk_window_get_decorated (GtkWindow *window) @@ -3880,7 +3880,7 @@ gtk_window_set_deletable (GtkWindow *window, * Returns whether the window has been set to have a close button * via gtk_window_set_deletable(). * - * Return value: %TRUE if the window has been set to have a close button + * Returns: %TRUE if the window has been set to have a close button * * Since: 2.10 **/ @@ -4209,7 +4209,7 @@ gtk_window_set_icon_list (GtkWindow *window, * The list is copied, but the reference count on each * member won’t be incremented. * - * Return value: (element-type GdkPixbuf) (transfer container): copy of window’s icon list + * Returns: (element-type GdkPixbuf) (transfer container): copy of window’s icon list **/ GList* gtk_window_get_icon_list (GtkWindow *window) @@ -4352,7 +4352,7 @@ gtk_window_get_icon_name (GtkWindow *window) * called gtk_window_set_icon_list(), gets the first icon in * the icon list). * - * Return value: (transfer none): icon for window + * Returns: (transfer none): icon for window **/ GdkPixbuf* gtk_window_get_icon (GtkWindow *window) @@ -4605,7 +4605,7 @@ gtk_window_set_default_icon_from_file (const gchar *filename, * but the pixbufs in the list have not had their reference count * incremented. * - * Return value: (element-type GdkPixbuf) (transfer container): copy of default icon list + * Returns: (element-type GdkPixbuf) (transfer container): copy of default icon list **/ GList* gtk_window_get_default_icon_list (void) @@ -7549,7 +7549,7 @@ _gtk_window_query_nonaccels (GtkWindow *window, * however in some cases it may be useful to call this directly when * overriding the standard key handling for a toplevel window. * - * Return value: %TRUE if a widget in the focus chain handled the event. + * Returns: %TRUE if a widget in the focus chain handled the event. * * Since: 2.4 */ @@ -10464,7 +10464,7 @@ gtk_window_set_resizable (GtkWindow *window, * * Gets the value set by gtk_window_set_resizable(). * - * Return value: %TRUE if the user can resize the window + * Returns: %TRUE if the user can resize the window **/ gboolean gtk_window_get_resizable (GtkWindow *window) @@ -10515,7 +10515,7 @@ gtk_window_set_gravity (GtkWindow *window, * * Gets the value set by gtk_window_set_gravity(). * - * Return value: (transfer none): window gravity + * Returns: (transfer none): window gravity **/ GdkGravity gtk_window_get_gravity (GtkWindow *window) @@ -10736,7 +10736,7 @@ gtk_window_check_screen (GtkWindow *window) * * Returns the #GdkScreen associated with @window. * - * Return value: (transfer none): a #GdkScreen. + * Returns: (transfer none): a #GdkScreen. * * Since: 2.2 */ @@ -10760,7 +10760,7 @@ gtk_window_get_screen (GtkWindow *window) * differently in an active window from a widget in an inactive window. * See gtk_window_has_toplevel_focus() * - * Return value: %TRUE if the window part of the current active window. + * Returns: %TRUE if the window part of the current active window. * * Since: 2.4 **/ @@ -10780,7 +10780,7 @@ gtk_window_is_active (GtkWindow *window) * For real toplevel windows, this is identical to gtk_window_is_active(), * but for embedded windows, like #GtkPlug, the results will differ. * - * Return value: %TRUE if the input focus is within this GtkWindow + * Returns: %TRUE if the input focus is within this GtkWindow * * Since: 2.4 **/ @@ -10826,7 +10826,7 @@ gtk_window_group_class_init (GtkWindowGroupClass *klass) * Creates a new #GtkWindowGroup object. Grabs added with * gtk_grab_add() only affect windows within the same #GtkWindowGroup. * - * Return value: a new #GtkWindowGroup. + * Returns: a new #GtkWindowGroup. **/ GtkWindowGroup * gtk_window_group_new (void) @@ -11010,7 +11010,7 @@ gtk_window_get_group (GtkWindow *window) * * Returns whether @window has an explicit window group. * - * Return value: %TRUE if @window has an explicit window group. + * Returns: %TRUE if @window has an explicit window group. * * Since 2.22 **/ @@ -11454,7 +11454,7 @@ gtk_XParseGeometry (const char *string, * } * ]| * - * Return value: %TRUE if string was parsed successfully + * Returns: %TRUE if string was parsed successfully **/ gboolean gtk_window_parse_geometry (GtkWindow *window, @@ -11695,7 +11695,7 @@ gtk_window_free_key_hash (GtkWindow *window) * however in some cases it may be useful to call this directly when * overriding the standard key handling for a toplevel window. * - * Return value: %TRUE if a mnemonic or accelerator was found and activated. + * Returns: %TRUE if a mnemonic or accelerator was found and activated. * * Since: 2.4 */ @@ -11961,7 +11961,7 @@ gtk_window_set_auto_startup_notification (gboolean setting) * * Gets the type of the window. See #GtkWindowType. * - * Return value: the type of the window + * Returns: the type of the window * * Since: 2.20 **/ diff --git a/gtk/gtkxembed.c b/gtk/gtkxembed.c index 88a9304ea9..97d3606f8a 100644 --- a/gtk/gtkxembed.c +++ b/gtk/gtkxembed.c @@ -95,7 +95,7 @@ _gtk_xembed_set_focus_wrapped (void) * Gets whether the current focus sequence has wrapped around * to the beginning of the ultimate toplevel. * - * Return value: %TRUE if the focus sequence has wrapped around. + * Returns: %TRUE if the focus sequence has wrapped around. **/ gboolean _gtk_xembed_get_focus_wrapped (void) diff --git a/modules/printbackends/cups/gtkprintbackendcups.c b/modules/printbackends/cups/gtkprintbackendcups.c index f9ab5d0f81..36e7f0fb78 100644 --- a/modules/printbackends/cups/gtkprintbackendcups.c +++ b/modules/printbackends/cups/gtkprintbackendcups.c @@ -311,7 +311,7 @@ gtk_print_backend_cups_get_type (void) * implements the #GtkPrintBackend interface with direct access to * the filesystem using Unix/Linux API calls * - * Return value: the new #GtkPrintBackendCups object + * Returns: the new #GtkPrintBackendCups object */ GtkPrintBackend * gtk_print_backend_cups_new (void) diff --git a/modules/printbackends/cups/gtkprintercups.c b/modules/printbackends/cups/gtkprintercups.c index 383bf90420..880c88b22c 100644 --- a/modules/printbackends/cups/gtkprintercups.c +++ b/modules/printbackends/cups/gtkprintercups.c @@ -542,7 +542,7 @@ colord_printer_details_aquired_cb (GtkPrinterCups *printer, * * Creates a new #GtkPrinterCups. * - * Return value: a new #GtkPrinterCups + * Returns: a new #GtkPrinterCups * * Since: 2.10 **/ diff --git a/modules/printbackends/file/gtkprintbackendfile.c b/modules/printbackends/file/gtkprintbackendfile.c index b6872421be..44c3ffbca6 100644 --- a/modules/printbackends/file/gtkprintbackendfile.c +++ b/modules/printbackends/file/gtkprintbackendfile.c @@ -160,7 +160,7 @@ gtk_print_backend_file_get_type (void) * implements the #GtkPrintBackend interface with direct access to * the filesystem using Unix/Linux API calls * - * Return value: the new #GtkPrintBackendFile object + * Returns: the new #GtkPrintBackendFile object **/ GtkPrintBackend * gtk_print_backend_file_new (void) diff --git a/modules/printbackends/lpr/gtkprintbackendlpr.c b/modules/printbackends/lpr/gtkprintbackendlpr.c index 29e415244b..4257771dbf 100644 --- a/modules/printbackends/lpr/gtkprintbackendlpr.c +++ b/modules/printbackends/lpr/gtkprintbackendlpr.c @@ -139,7 +139,7 @@ gtk_print_backend_lpr_get_type (void) * implements the #GtkPrintBackend interface with direct access to * the filesystem using Unix/Linux API calls * - * Return value: the new #GtkPrintBackendLpr object + * Returns: the new #GtkPrintBackendLpr object **/ GtkPrintBackend * gtk_print_backend_lpr_new (void) diff --git a/modules/printbackends/papi/gtkprintbackendpapi.c b/modules/printbackends/papi/gtkprintbackendpapi.c index 001c57e56c..d3aa729739 100644 --- a/modules/printbackends/papi/gtkprintbackendpapi.c +++ b/modules/printbackends/papi/gtkprintbackendpapi.c @@ -157,7 +157,7 @@ gtk_print_backend_papi_get_type (void) * implements the #GtkPrintBackend interface with direct access to * the filesystem using Unix/Linux API calls * - * Return value: the new #GtkPrintBackendPapi object + * Returns: the new #GtkPrintBackendPapi object **/ GtkPrintBackend * gtk_print_backend_papi_new (void) diff --git a/modules/printbackends/papi/gtkprinterpapi.c b/modules/printbackends/papi/gtkprinterpapi.c index 816bce0867..72e0719ff4 100644 --- a/modules/printbackends/papi/gtkprinterpapi.c +++ b/modules/printbackends/papi/gtkprinterpapi.c @@ -89,7 +89,7 @@ gtk_printer_papi_finalize (GObject *object) * * Creates a new #GtkPrinterPapi. * - * Return value: a new #GtkPrinterPapi + * Returns: a new #GtkPrinterPapi * * Since: 2.10 **/ diff --git a/modules/printbackends/test/gtkprintbackendtest.c b/modules/printbackends/test/gtkprintbackendtest.c index b51fedf152..f379d1a2d5 100644 --- a/modules/printbackends/test/gtkprintbackendtest.c +++ b/modules/printbackends/test/gtkprintbackendtest.c @@ -158,7 +158,7 @@ gtk_print_backend_test_get_type (void) * implements the #GtkPrintBackend interface with direct access to * the testsystem using Unix/Linux API calls * - * Return value: the new #GtkPrintBackendTest object + * Returns: the new #GtkPrintBackendTest object **/ GtkPrintBackend * gtk_print_backend_test_new (void) |