AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: use Returns: consistently

Browse Source 
Instead of Return value:
This commit is contained in:
William Jon McCann 2014-02-19 18:49:43 -05:00
parent a6084e264d
commit 469d333aa2
219 changed files with 1612 additions and 1612 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gdk/gdk.c
View File

@ -382,7 +382,7 @@ gdk_get_display_arg_name (void)
* display has previously been set, simply returns that. An internal * display has previously been set, simply returns that. An internal
* function that should not be used by applications. * 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. * opened, otherwise %NULL.
**/ **/
GdkDisplay * 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 * Since: 2.12
*/ */
@ -736,7 +736,7 @@ gdk_threads_add_idle_full (gint priority,
* *
* See gdk_threads_add_idle_full(). * 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 * 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 * Since: 2.12
*/ */
@ -842,7 +842,7 @@ gdk_threads_add_timeout_full (gint priority,
* *
* See gdk_threads_add_timeout_full(). * 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 * 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 * 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. * 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 * Since: 2.14
*/ */
@ -907,7 +907,7 @@ gdk_threads_add_timeout_seconds_full (gint priority,
* *
* For details, see gdk_threads_add_timeout_full(). * 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 * Since: 2.14
*/ */

10
gdk/gdkcolor.c
View File

@ -51,7 +51,7 @@
* *
* The result must be freed using gdk_color_free(). * The result must be freed using gdk_color_free().
* *
* Return value: a copy of @color * Returns: a copy of @color
*/ */
GdkColor* GdkColor*
gdk_color_copy (const GdkColor *color) gdk_color_copy (const GdkColor *color)
@ -86,7 +86,7 @@ gdk_color_free (GdkColor *color)
* A hash function suitable for using for a hash * A hash function suitable for using for a hash
* table that stores #GdkColors. * table that stores #GdkColors.
* *
* Return value: The hash function applied to @color * Returns: The hash function applied to @color
*/ */
guint guint
gdk_color_hash (const GdkColor *color) gdk_color_hash (const GdkColor *color)
@ -104,7 +104,7 @@ gdk_color_hash (const GdkColor *color)
* *
* Compares two colors. * Compares two colors.
* *
* Return value: %TRUE if the two colors compare equal * Returns: %TRUE if the two colors compare equal
*/ */
gboolean gboolean
gdk_color_equal (const GdkColor *colora, 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” * (White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff”
* and “\#ffffffffffff”). * and “\#ffffffffffff”).
* *
* Return value: %TRUE if the parsing succeeded * Returns: %TRUE if the parsing succeeded
*/ */
gboolean gboolean
gdk_color_parse (const gchar *spec, 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(). * 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 * Since: 2.12
*/ */

8
gdk/gdkcursor.c
View File

@ -153,7 +153,7 @@ gdk_cursor_init (GdkCursor *cursor)
* *
* Adds a reference to @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 * 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. * To make the cursor invisible, use %GDK_BLANK_CURSOR.
* *
* Return value: a new #GdkCursor * Returns: a new #GdkCursor
*/ */
GdkCursor* GdkCursor*
gdk_cursor_new (GdkCursorType cursor_type) gdk_cursor_new (GdkCursorType cursor_type)
@ -205,7 +205,7 @@ gdk_cursor_new (GdkCursorType cursor_type)
* *
* Returns the cursor type for this cursor. * Returns the cursor type for this cursor.
* *
* Return value: a #GdkCursorType * Returns: a #GdkCursorType
* *
* Since: 2.22 * 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) * - ![](sb_v_double_arrow.png) #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter)
* - #GDK_BLANK_CURSOR (Blank cursor). Since 2.16 * - #GDK_BLANK_CURSOR (Blank cursor). Since 2.16
* *
* Return value: a new #GdkCursor * Returns: a new #GdkCursor
* *
* Since: 2.2 * Since: 2.2
**/ **/

4
gdk/gdkdeprecated.c
View File

@ -53,7 +53,7 @@ gdk_pointer_ungrab (guint32 time)
* Note that this does not take the inmplicit pointer grab on button * Note that this does not take the inmplicit pointer grab on button
* presses into account. * 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. * 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 * NOTE: For multihead-aware widgets or applications use
* gdk_display_get_window_at_pointer() instead. * 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. * Deprecated: 3.0: Use gdk_device_get_window_at_position() instead.
**/ **/

12
gdk/gdkdevice.c
View File

@ -597,7 +597,7 @@ gdk_device_get_window_at_position (GdkDevice *device,
* more motion events delivered directly, independent of the windowing * more motion events delivered directly, independent of the windowing
* system. * 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. * at least one event was found.
**/ **/
gboolean gboolean
@ -667,7 +667,7 @@ gdk_device_free_history (GdkTimeCoord **events,
* *
* Determines the name of the device. * Determines the name of the device.
* *
* Return value: a name * Returns: a name
* *
* Since: 2.20 * Since: 2.20
**/ **/
@ -685,7 +685,7 @@ gdk_device_get_name (GdkDevice *device)
* *
* Determines whether the pointer follows device motion. * 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 * Since: 2.20
**/ **/
@ -704,7 +704,7 @@ gdk_device_get_has_cursor (GdkDevice *device)
* *
* Determines the type of the device. * Determines the type of the device.
* *
* Return value: a #GdkInputSource * Returns: a #GdkInputSource
* *
* Since: 2.20 * Since: 2.20
**/ **/
@ -722,7 +722,7 @@ gdk_device_get_source (GdkDevice *device)
* *
* Determines the mode of the device. * Determines the mode of the device.
* *
* Return value: a #GdkInputSource * Returns: a #GdkInputSource
* *
* Since: 2.20 * 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, * Interprets an array of double as axis values for a given device,
* and locates the value in the array for a given axis use. * 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 gboolean
gdk_device_get_axis (GdkDevice *device, gdk_device_get_axis (GdkDevice *device,

20
gdk/gdkdisplay.c
View File

@ -306,7 +306,7 @@ gdk_display_is_closed (GdkDisplay *display)
* Gets the next #GdkEvent to be processed for @display, fetching events from the * Gets the next #GdkEvent to be processed for @display, fetching events from the
* windowing system if necessary. * 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(). * are pending. The returned #GdkEvent should be freed with gdk_event_free().
* *
* Since: 2.2 * 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 * not get more events from the windowing system. It only checks the events
* that have already been moved to the GDK event queue.) * 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 * if no events are in the queue. The returned #GdkEvent should be freed with
* gdk_event_free(). * gdk_event_free().
* *
@ -1288,7 +1288,7 @@ _gdk_display_pointer_info_foreach (GdkDisplay *display,
* Determines information about the current keyboard grab. * Determines information about the current keyboard grab.
* This is not public API and must not be used by applications. * 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. * keyboard grabbed.
**/ **/
gboolean gboolean
@ -1553,7 +1553,7 @@ gdk_display_flush (GdkDisplay *display)
* on @display. This window is implicitly created by GDK. * on @display. This window is implicitly created by GDK.
* See gdk_window_set_group(). * See gdk_window_set_group().
* *
* Return value: (transfer none): The default group leader window * Returns: (transfer none): The default group leader window
* for @display * for @display
* *
* Since: 2.4 * Since: 2.4
@ -1573,7 +1573,7 @@ gdk_display_get_default_group (GdkDisplay *display)
* Returns whether #GdkEventOwnerChange events will be * Returns whether #GdkEventOwnerChange events will be
* sent when the owner of a selection changes. * sent when the owner of a selection changes.
* *
* Return value: whether #GdkEventOwnerChange events will * Returns: whether #GdkEventOwnerChange events will
* be sent. * be sent.
* *
* Since: 2.6 * Since: 2.6
@ -1595,7 +1595,7 @@ gdk_display_supports_selection_notification (GdkDisplay *display)
* Request #GdkEventOwnerChange events for ownership changes * Request #GdkEventOwnerChange events for ownership changes
* of the selection named by the given atom. * of the selection named by the given atom.
* *
* Return value: whether #GdkEventOwnerChange events will * Returns: whether #GdkEventOwnerChange events will
* be sent. * be sent.
* *
* Since: 2.6 * Since: 2.6
@ -1727,7 +1727,7 @@ gdk_display_supports_composite (GdkDisplay *display)
* Returns the list of available input devices attached to @display. * Returns the list of available input devices attached to @display.
* The list is statically allocated and should not be freed. * 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 * a list of #GdkDevice
* *
* Since: 2.2 * Since: 2.2
@ -1780,7 +1780,7 @@ gdk_display_get_app_launch_context (GdkDisplay *display)
* *
* Opens a 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 * if the display could not be opened
* *
* Since: 2.2 * Since: 2.2
@ -2069,7 +2069,7 @@ _gdk_display_create_window (GdkDisplay *display)
* *
* Returns the #GdkKeymap attached to @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 * 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 * sync for you, so you had to gdk_flush() if your last
* call to Xlib was not a blocking round trip. * 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 gint
gdk_error_trap_pop (void) gdk_error_trap_pop (void)

4
gdk/gdkdisplaymanager.c
View File

@ -392,7 +392,7 @@ gdk_display_manager_set_default_display (GdkDisplayManager *manager,
* *
* List all currently open displays. * 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() * allocated #GSList of #GdkDisplay objects. Free with g_slist_free()
* when you are done with it. * when you are done with it.
* *
@ -411,7 +411,7 @@ gdk_display_manager_list_displays (GdkDisplayManager *manager)
* *
* Opens a 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 * if the display could not be opened
* *
* Since: 3.0 * Since: 3.0

16
gdk/gdkdnd.c
View File

@ -51,7 +51,7 @@
* *
* Retrieves the list of targets of the context. * 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 * Since: 2.22
**/ **/
@ -70,7 +70,7 @@ gdk_drag_context_list_targets (GdkDragContext *context)
* Determines the bitmask of actions proposed by the source if * Determines the bitmask of actions proposed by the source if
* gdk_drag_context_get_suggested_action() returns GDK_ACTION_ASK. * gdk_drag_context_get_suggested_action() returns GDK_ACTION_ASK.
* *
* Return value: the #GdkDragAction flags * Returns: the #GdkDragAction flags
* *
* Since: 2.22 * Since: 2.22
**/ **/
@ -88,7 +88,7 @@ gdk_drag_context_get_actions (GdkDragContext *context)
* *
* Determines the suggested drag action of the context. * Determines the suggested drag action of the context.
* *
* Return value: a #GdkDragAction value * Returns: a #GdkDragAction value
* *
* Since: 2.22 * Since: 2.22
**/ **/
@ -106,7 +106,7 @@ gdk_drag_context_get_suggested_action (GdkDragContext *context)
* *
* Determines the action chosen by the drag destination. * Determines the action chosen by the drag destination.
* *
* Return value: a #GdkDragAction value * Returns: a #GdkDragAction value
* *
* Since: 2.22 * Since: 2.22
**/ **/
@ -124,7 +124,7 @@ gdk_drag_context_get_selected_action (GdkDragContext *context)
* *
* Returns the #GdkWindow where the DND operation started. * Returns the #GdkWindow where the DND operation started.
* *
* Return value: (transfer none): a #GdkWindow * Returns: (transfer none): a #GdkWindow
* *
* Since: 2.22 * Since: 2.22
**/ **/
@ -142,7 +142,7 @@ gdk_drag_context_get_source_window (GdkDragContext *context)
* *
* Returns the destination windw for the DND operation. * Returns the destination windw for the DND operation.
* *
* Return value: (transfer none): a #GdkWindow * Returns: (transfer none): a #GdkWindow
* *
* Since: 3.0 * Since: 3.0
**/ **/
@ -427,7 +427,7 @@ gdk_drop_finish (GdkDragContext *context,
* handling a %GDK_DROP_FINISHED event, its return value is * handling a %GDK_DROP_FINISHED event, its return value is
* meaningless at other times. * meaningless at other times.
* *
* Return value: %TRUE if the drop was successful. * Returns: %TRUE if the drop was successful.
* *
* Since: 2.6 * Since: 2.6
**/ **/
@ -445,7 +445,7 @@ gdk_drag_drop_succeeded (GdkDragContext *context)
* *
* Returns the selection atom for the current source window. * 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 GdkAtom
gdk_drag_get_selection (GdkDragContext *context) gdk_drag_get_selection (GdkDragContext *context)

42
gdk/gdkevents.c
View File

@ -80,7 +80,7 @@ _gdk_event_emit (GdkEvent *event)
* Find the first event on the queue that is not still * Find the first event on the queue that is not still
* being filled in. * 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* GList*
_gdk_event_queue_find_first (GdkDisplay *display) _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 * Removes and returns the first event from the event
* queue that is not still being filled in. * 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. * to the caller.
**/ **/
GdkEvent* GdkEvent*
@ -365,7 +365,7 @@ gdk_event_handler_set (GdkEventFunc func,
* *
* Checks if any events are ready to be processed for any display. * 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 gboolean
gdk_events_pending (void) gdk_events_pending (void)
@ -406,7 +406,7 @@ gdk_events_pending (void)
* on, fetching events from the windowing system if necessary. * on, fetching events from the windowing system if necessary.
* See gdk_display_get_event(). * 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(). * are pending. The returned #GdkEvent should be freed with gdk_event_free().
**/ **/
GdkEvent* GdkEvent*
@ -435,7 +435,7 @@ gdk_event_get (void)
* If there is an event waiting in the event queue of some open * If there is an event waiting in the event queue of some open
* display, returns a copy of it. See gdk_display_peek_event(). * 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 * events are in any queues. The returned #GdkEvent should be freed with
* gdk_event_free(). * 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. * 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(). * should be freed with gdk_event_free().
* *
* Since: 2.2 * 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 * Copies a #GdkEvent, copying or incrementing the reference count of the
* resources associated with it (e.g. #GdkWindow’s and strings). * 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(). * gdk_event_free().
**/ **/
GdkEvent* GdkEvent*
@ -820,7 +820,7 @@ gdk_event_free (GdkEvent *event)
* *
* Extracts the #GdkWindow associated with an 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 * 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 the time stamp from @event, if there is one; otherwise
* returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME. * 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 guint32
gdk_event_get_time (const GdkEvent *event) 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 * in the event. @event may be %NULL, in which case it’s treated
* as if the event had no state field. * 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 gboolean
gdk_event_get_state (const GdkEvent *event, 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. * 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 gboolean
gdk_event_get_coords (const GdkEvent *event, 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. * 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 gboolean
gdk_event_get_root_coords (const GdkEvent *event, 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. * 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 * Since: 3.2
**/ **/
@ -1172,7 +1172,7 @@ gdk_event_get_button (const GdkEvent *event,
* *
* Extracts the click count from an 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 * Since: 3.2
*/ */
@ -1215,7 +1215,7 @@ gdk_event_get_click_count (const GdkEvent *event,
* *
* Extracts the keyval from an 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 * Since: 3.2
*/ */
@ -1250,7 +1250,7 @@ gdk_event_get_keyval (const GdkEvent *event,
* *
* Extracts the hardware keycode from an 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 * Since: 3.2
*/ */
@ -1285,7 +1285,7 @@ gdk_event_get_keycode (const GdkEvent *event,
* *
* Extracts the scroll direction from an 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 * 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 * Extract the axis value for a particular axis use from
* an event structure. * 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 gboolean
gdk_event_get_axis (const GdkEvent *event, gdk_event_get_axis (const GdkEvent *event,
@ -1921,7 +1921,7 @@ gdk_event_set_screen (GdkEvent *event,
* to which `event->motion.x_root` and * to which `event->motion.x_root` and
* `event->motion.y_root` are relative. * `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 * Since: 2.2
**/ **/
@ -1992,7 +1992,7 @@ gdk_set_show_events (gboolean show_events)
* *
* Gets whether event debugging output is enabled. * 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 gboolean
gdk_get_show_events (void) gdk_get_show_events (void)
@ -2225,7 +2225,7 @@ gdk_setting_get (const gchar *name,
* *
* Retrieves the type of the event. * Retrieves the type of the event.
* *
* Return value: a #GdkEventType * Returns: a #GdkEventType
* *
* Since: 3.10 * Since: 3.10
*/ */

6
gdk/gdkframeclock.c
View File

@ -259,7 +259,7 @@ gdk_frame_clock_init (GdkFrameClock *clock)
* time. * time.
* *
* Since: 3.8 * 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(). * of g_get_monotonic_time().
*/ */
gint64 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_history_start() and
* gdk_frame_clock_get_frame_counter(), inclusive. * 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 * that is available in the internal frame history of the
* #GdkFrameClock. * #GdkFrameClock.
* Since: 3.8 * 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 * for the current frame or a recent frame. The #GdkFrameTimings
* object may not yet be complete: see gdk_frame_timings_get_complete(). * 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 * frame, or %NULL if it is not available. See
* gdk_frame_clock_get_history_start(). * gdk_frame_clock_get_history_start().
* Since: 3.8 * Since: 3.8

8
gdk/gdkkeys.c
View File

@ -398,7 +398,7 @@ gdk_keymap_get_modifier_state (GdkKeymap *keymap)
* The returned array should be freed * The returned array should be freed
* with g_free(). * with g_free().
* *
* Return value: %TRUE if keys were found and returned * Returns: %TRUE if keys were found and returned
**/ **/
gboolean gboolean
gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap, 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 * this function, since the effective group/level may not be
* the same as the current keyboard state. * 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 guint
gdk_keymap_lookup_key (GdkKeymap *keymap, 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 * you store accelerators, you should always store them with consumed
* modifiers removed. Store `<Control>plus`, not `<Control><Shift>plus`, * 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 gboolean
gdk_keymap_translate_keyboard_state (GdkKeymap *keymap, gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
@ -680,7 +680,7 @@ gdk_keymap_get_modifier_mask (GdkKeymap *keymap,
* `gdk/gdkkeysyms.h` header file * `gdk/gdkkeysyms.h` header file
* but without the leading “GDK_KEY_”. * 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 * or %NULL if @keyval is not a valid key. The string should not be
* modified. * modified.
*/ */

4
gdk/gdkkeyuni.c
View File

@ -879,7 +879,7 @@ static const struct {
* Convert from a GDK key symbol to the corresponding ISO10646 (Unicode) * Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
* character. * character.
* *
* Return value: the corresponding unicode character, or 0 if there * Returns: the corresponding unicode character, or 0 if there
* is no corresponding character. * is no corresponding character.
**/ **/
guint32 guint32
@ -1678,7 +1678,7 @@ static const struct {
* *
* Convert from a ISO10646 character to a key symbol. * 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, * or, if there is no corresponding symbol,
* wc | 0x01000000 * wc | 0x01000000
**/ **/

8
gdk/gdkpango.c
View File

@ -212,7 +212,7 @@ layout_iter_get_line_clip_region (PangoLayoutIter *iter,
* the clip region. The clip region is mainly useful for highlightling parts * the clip region. The clip region is mainly useful for highlightling parts
* of text, such as when text is selected. * 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* cairo_region_t*
gdk_pango_layout_line_get_clip_region (PangoLayoutLine *line, 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 * the clip region. The clip region is mainly useful for highlightling parts
* of text, such as when text is selected. * 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* cairo_region_t*
gdk_pango_layout_get_clip_region (PangoLayout *layout, 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 * is more convenient if you want to keep a context around and track
* changes to the screen’s font rendering settings. * 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 * PangoContext *
gdk_pango_context_get (void) 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 * is more convenient if you want to keep a context around and track
* changes to the screen’s font rendering settings. * 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 * Since: 2.2
**/ **/

4
gdk/gdkpixbuf-drawable.c
View File

@ -77,7 +77,7 @@
* (In short, there are several ways this function can fail, and if it fails * (In short, there are several ways this function can fail, and if it fails
* it returns %NULL; so check the return value.) * 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 * count of 1, or %NULL on error
*/ */
GdkPixbuf * GdkPixbuf *
@ -225,7 +225,7 @@ convert_no_alpha (guchar *dest_data,
* This function will create an RGB pixbuf with 8 bits per channel. * This function will create an RGB pixbuf with 8 bits per channel.
* The pixbuf will contain an alpha channel if the @surface contains one. * 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 * count of 1, or %NULL on error
*/ */
GdkPixbuf * GdkPixbuf *

4
gdk/gdkrgba.c
View File

@ -281,7 +281,7 @@ gdk_rgba_parse (GdkRGBA *rgba,
* A hash function suitable for using for a hash * A hash function suitable for using for a hash
* table that stores #GdkRGBAs. * table that stores #GdkRGBAs.
* *
* Return value: The hash value for @p * Returns: The hash value for @p
* *
* Since: 3.0 * Since: 3.0
*/ */
@ -303,7 +303,7 @@ gdk_rgba_hash (gconstpointer p)
* *
* Compares two RGBA colors. * Compares two RGBA colors.
* *
* Return value: %TRUE if the two colors compare equal * Returns: %TRUE if the two colors compare equal
* *
* Since: 3.0 * Since: 3.0
*/ */

28
gdk/gdkscreen.c
View File

@ -336,7 +336,7 @@ gdk_screen_get_monitor_at_window (GdkScreen *screen,
* *
* Returns the width of the default screen in pixels. * 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 gint
gdk_screen_width (void) gdk_screen_width (void)
@ -349,7 +349,7 @@ gdk_screen_width (void)
* *
* Returns the height of the default screen in pixels. * 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 gint
gdk_screen_height (void) gdk_screen_height (void)
@ -363,7 +363,7 @@ gdk_screen_height (void)
* Returns the width of the default screen in millimeters. * Returns the width of the default screen in millimeters.
* Note that on many X servers this value will not be correct. * 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. * though it is not always correct.
**/ **/
gint gint
@ -378,7 +378,7 @@ gdk_screen_width_mm (void)
* Returns the height of the default screen in millimeters. * Returns the height of the default screen in millimeters.
* Note that on many X servers this value will not be correct. * 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. * though it is not always correct.
**/ **/
gint gint
@ -427,7 +427,7 @@ gdk_screen_set_font_options (GdkScreen *screen,
* *
* Gets any options previously set with gdk_screen_set_font_options(). * 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. * font options have been set.
* *
* Since: 2.10 * Since: 2.10
@ -477,7 +477,7 @@ gdk_screen_set_resolution (GdkScreen *screen,
* Gets the resolution for font handling on the screen; see * Gets the resolution for font handling on the screen; see
* gdk_screen_set_resolution() for full details. * 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. * has been set.
* *
* Since: 2.10 * 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. * 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 * a list of visuals; the list must be freed, but not its contents
* *
* Since: 2.2 * Since: 2.2
@ -869,7 +869,7 @@ gdk_screen_list_visuals (GdkScreen *screen)
* This is the visual for the root window of the display. * This is the visual for the root window of the display.
* The return value should not be freed. * The return value should not be freed.
* *
* Return value: (transfer none): the system visual * Returns: (transfer none): the system visual
* *
* Since: 2.2 * 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 * For setting an overall opacity for a top-level window, see
* gdk_window_set_opacity(). * 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. * alpha channel or %NULL if the capability is not available.
* *
* Since: 2.8 * Since: 2.8
@ -923,7 +923,7 @@ gdk_screen_get_rgba_visual (GdkScreen *screen)
* On X11 this function returns whether a compositing manager is * On X11 this function returns whether a compositing manager is
* compositing @screen. * 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. * expected to have their alpha channels drawn correctly on the screen.
* *
* Since: 2.10 * Since: 2.10
@ -943,7 +943,7 @@ gdk_screen_is_composited (GdkScreen *screen)
* Determines the name to pass to gdk_display_open() to get * Determines the name to pass to gdk_display_open() to get
* a #GdkDisplay with this screen as the default screen. * 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 * 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 * The returned window should be unrefed using g_object_unref() when
* no longer needed. * 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 * 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 * windows it contains, so it should be freed using g_list_free() and
* its windows unrefed using g_object_unref() when no longer needed. * 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, * a list of #GdkWindows for the current window stack,
* or %NULL. * or %NULL.
* *
@ -1063,7 +1063,7 @@ gdk_screen_get_setting (GdkScreen *screen,
* where it is better to use gdk_window_get_scale_factor() instead. * where it is better to use gdk_window_get_scale_factor() instead.
* *
* Since: 3.10 * Since: 3.10
* Return value: the scale factor * Returns: the scale factor
*/ */
gint gint
gdk_screen_get_monitor_scale_factor (GdkScreen *screen, gdk_screen_get_monitor_scale_factor (GdkScreen *screen,

6
gdk/gdkselection.c
View File

@ -241,7 +241,7 @@ gdk_selection_send_notify_for_display (GdkDisplay *display,
* will not be used by applications, who should use the #GtkClipboard * will not be used by applications, who should use the #GtkClipboard
* API instead. * API instead.
* *
* Return value: the length of the retrieved data. * Returns: the length of the retrieved data.
*/ */
gint gint
gdk_selection_property_get (GdkWindow *requestor, gdk_selection_property_get (GdkWindow *requestor,
@ -289,7 +289,7 @@ gdk_selection_convert (GdkWindow *requestor,
* Converts a text property in the given encoding to * Converts a text property in the given encoding to
* a list of UTF-8 strings. * 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 * 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 * is not specified; it may be as pseudo-escape sequences
* \x{ABCD}, or it may be in some other form of approximation. * \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 * conversion failed. (It should not fail for
* any properly formed UTF-8 string unless system * any properly formed UTF-8 string unless system
* limits like memory or file descriptors are exceeded.) * limits like memory or file descriptors are exceeded.)

28
gdk/gdkvisual.c
View File

@ -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. * 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 * a list of visuals; the list must be freed, but not its contents
*/ */
GList* GList*
@ -100,7 +100,7 @@ gdk_list_visuals (void)
* This is the visual for the root window of the display. * This is the visual for the root window of the display.
* The return value should not be freed. * The return value should not be freed.
* *
* Return value: (transfer none): system visual * Returns: (transfer none): system visual
*/ */
GdkVisual* GdkVisual*
gdk_visual_get_system (void) 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 * means “largest,” i.e. 32 preferred over 24 preferred over 8 bits
* per pixel. * per pixel.
* *
* Return value: best available depth * Returns: best available depth
*/ */
gint gint
gdk_visual_get_best_depth (void) 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 the best available visual type for the default GDK screen.
* *
* Return value: best visual type * Returns: best visual type
*/ */
GdkVisualType GdkVisualType
gdk_visual_get_best_type (void) 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 * Get the visual with the most available colors for the default
* GDK screen. The return value should not be freed. * GDK screen. The return value should not be freed.
* *
* Return value: (transfer none): best visual * Returns: (transfer none): best visual
*/ */
GdkVisual* GdkVisual*
gdk_visual_get_best (void) gdk_visual_get_best (void)
@ -165,7 +165,7 @@ gdk_visual_get_best (void)
* over grayscale or fixed-colormap visuals. The return value should * over grayscale or fixed-colormap visuals. The return value should
* not be freed. %NULL may be returned if no visual supports @depth. * 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* GdkVisual*
gdk_visual_get_best_with_depth (gint depth) 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 * should not be freed. %NULL may be returned if no visual has type
* @visual_type. * @visual_type.
* *
* Return value: (transfer none): best visual of the given type * Returns: (transfer none): best visual of the given type
*/ */
GdkVisual* GdkVisual*
gdk_visual_get_best_with_type (GdkVisualType visual_type) 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 * Combines gdk_visual_get_best_with_depth() and
* gdk_visual_get_best_with_type(). * 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 * @visual_type, or %NULL if none
*/ */
GdkVisual* GdkVisual*
@ -265,7 +265,7 @@ gdk_query_visual_types (GdkVisualType **visual_types,
* *
* Returns the type of visual this is (PseudoColor, TrueColor, etc). * 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 * Since: 2.22
*/ */
@ -283,7 +283,7 @@ gdk_visual_get_visual_type (GdkVisual *visual)
* *
* Returns the bit depth of this 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 * Since: 2.22
*/ */
@ -301,7 +301,7 @@ gdk_visual_get_depth (GdkVisual *visual)
* *
* Returns the byte order of this 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 * Since: 2.22
*/ */
@ -319,7 +319,7 @@ gdk_visual_get_byte_order (GdkVisual *visual)
* *
* Returns the size of a colormap for this 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 * 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. * 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 * Since: 2.22
*/ */
@ -454,7 +454,7 @@ gdk_visual_get_blue_pixel_details (GdkVisual *visual,
* *
* Gets the screen to which this visual belongs * 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 * Since: 2.2
*/ */

78
gdk/gdkwindow.c
View File

@ -1223,7 +1223,7 @@ sync_native_window_stack_position (GdkWindow *window)
* more details. Note: to use this on displays other than the default * more details. Note: to use this on displays other than the default
* display, @parent must be specified. * display, @parent must be specified.
* *
* Return value: (transfer full): the new #GdkWindow * Returns: (transfer full): the new #GdkWindow
**/ **/
GdkWindow* GdkWindow*
gdk_window_new (GdkWindow *parent, gdk_window_new (GdkWindow *parent,
@ -2105,7 +2105,7 @@ gdk_window_get_user_data (GdkWindow *window,
* *
* Gets the type of the window. See #GdkWindowType. * Gets the type of the window. See #GdkWindowType.
* *
* Return value: type of window * Returns: type of window
**/ **/
GdkWindowType GdkWindowType
gdk_window_get_window_type (GdkWindow *window) 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. * Gets the #GdkVisual describing the pixel format of @window.
* *
* Return value: (transfer none): a #GdkVisual * Returns: (transfer none): a #GdkVisual
* *
* Since: 2.24 * Since: 2.24
**/ **/
@ -2139,7 +2139,7 @@ gdk_window_get_visual (GdkWindow *window)
* *
* Gets the #GdkScreen associated with a #GdkWindow. * 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 * Since: 2.24
**/ **/
@ -2157,7 +2157,7 @@ gdk_window_get_screen (GdkWindow *window)
* *
* Gets the #GdkDisplay associated with a #GdkWindow. * 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 * Since: 2.24
**/ **/
@ -2174,7 +2174,7 @@ gdk_window_get_display (GdkWindow *window)
* *
* Check to see if a window is destroyed.. * 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 * 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 * gdk_window_get_parent() will most likely not do what you expect if
* there are offscreen windows in the hierarchy. * there are offscreen windows in the hierarchy.
* *
* Return value: (transfer none): parent of @window * Returns: (transfer none): parent of @window
**/ **/
GdkWindow* GdkWindow*
gdk_window_get_parent (GdkWindow *window) gdk_window_get_parent (GdkWindow *window)
@ -2291,7 +2291,7 @@ gdk_window_get_parent (GdkWindow *window)
* *
* See also: gdk_offscreen_window_get_embedder() * 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 * 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 * gdk_window_get_toplevel() will most likely not do what you expect
* if there are offscreen windows in the hierarchy. * 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 * GdkWindow *
gdk_window_get_toplevel (GdkWindow *window) gdk_window_get_toplevel (GdkWindow *window)
@ -2349,7 +2349,7 @@ gdk_window_get_toplevel (GdkWindow *window)
* *
* See also: gdk_offscreen_window_get_embedder() * 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 * 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 * The returned list must be freed, but the elements in the
* list need not be. * list need not be.
* *
* Return value: (transfer container) (element-type GdkWindow): * Returns: (transfer container) (element-type GdkWindow):
* list of child windows inside @window * list of child windows inside @window
**/ **/
GList* GList*
@ -2400,7 +2400,7 @@ gdk_window_get_children (GdkWindow *window)
* Like gdk_window_get_children(), but does not copy the list of * Like gdk_window_get_children(), but does not copy the list of
* children, so the list does not need to be freed. * 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 * a reference to the list of child windows in @window
**/ **/
GList * GList *
@ -2429,7 +2429,7 @@ gdk_window_peek_children (GdkWindow *window)
* The list is returned in (relative) stacking order, i.e. the * The list is returned in (relative) stacking order, i.e. the
* lowest window is first. * lowest window is first.
* *
* Return value: (transfer container) (element-type GdkWindow): * Returns: (transfer container) (element-type GdkWindow):
* list of child windows inside @window * list of child windows inside @window
* *
* Since: 3.10 * Since: 3.10
@ -2571,7 +2571,7 @@ gdk_window_remove_filter (GdkWindow *window,
* The returned list should be freed with g_list_free(), but * The returned list should be freed with g_list_free(), but
* its elements need not be freed. * 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() * list of toplevel windows, free with g_list_free()
* *
* Since: 2.2 * 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 * Checks whether the window has been mapped (with gdk_window_show() or
* gdk_window_show_unraised()). * gdk_window_show_unraised()).
* *
* Return value: %TRUE if the window is mapped * Returns: %TRUE if the window is mapped
**/ **/
gboolean gboolean
gdk_window_is_visible (GdkWindow *window) 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 * we only check as far as we have GDK window parents, not to the root
* window.) * window.)
* *
* Return value: %TRUE if the window is viewable * Returns: %TRUE if the window is viewable
**/ **/
gboolean gboolean
gdk_window_is_viewable (GdkWindow *window) 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, * Gets the bitwise OR of the currently active window state flags,
* from the #GdkWindowState enumeration. * from the #GdkWindowState enumeration.
* *
* Return value: window state bitfield * Returns: window state bitfield
**/ **/
GdkWindowState GdkWindowState
gdk_window_get_state (GdkWindow *window) 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 * Note that calling cairo_reset_clip() on the resulting #cairo_t will
* produce undefined results, so avoid it at all costs. * 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. * cairo_destroy() when you are done drawing.
* *
* Since: 2.8 * 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 * gdk_window_get_update_area() returns %NULL. You are responsible for
* calling cairo_region_destroy() on the returned region if it’s non-%NULL. * 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 * cairo_region_t *
gdk_window_get_update_area (GdkWindow *window) 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 * The position is given in coordinates relative to the upper left
* corner of @window. * 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 * gdk_window_at_pointer()), or %NULL if the window containing the
* pointer isn’t known to GDK * 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 * The position is given in coordinates relative to the upper left
* corner of @window. * 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. * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK.
* *
* Since: 3.10 * 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. * 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. * gdk_device_get_window_at_position()), or %NULL if the window is not known to GDK.
* *
* Since: 3.0 * Since: 3.0
@ -4531,7 +4531,7 @@ gdk_window_get_device_position (GdkWindow *window,
* Obtains the root window (parent all other windows are inside) * Obtains the root window (parent all other windows are inside)
* for the default display and screen. * for the default display and screen.
* *
* Return value: (transfer none): the default root window * Returns: (transfer none): the default root window
**/ **/
GdkWindow * GdkWindow *
gdk_get_default_root_window (void) 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 * Gets the event mask for @window for all master input devices. See
* gdk_window_set_events(). * gdk_window_set_events().
* *
* Return value: event mask for @window * Returns: event mask for @window
**/ **/
GdkEventMask GdkEventMask
gdk_window_get_events (GdkWindow *window) 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 * there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window. * 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 * object is owned by the #GdkWindow and should not be unreferenced
* directly. Use gdk_window_set_cursor() to unset the cursor of the * directly. Use gdk_window_set_cursor() to unset the cursor of the
* window * window
@ -6128,7 +6128,7 @@ gdk_window_get_height (GdkWindow *window)
* gdk_window_get_geometry() which return the position of a window * gdk_window_get_geometry() which return the position of a window
* relative to its parent window.) * relative to its parent window.)
* *
* Return value: not meaningful, ignore * Returns: not meaningful, ignore
*/ */
gint gint
gdk_window_get_origin (GdkWindow *window, 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 * implementing scary features that involve deep knowledge of the
* windowing system. Don’t worry about it unless you have to. * 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 gboolean
gdk_window_set_static_gravities (GdkWindow *window, 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 * Determines whether or not the window manager is hinted that @window
* has modal behaviour. * 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 * 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 * Determines whether or not the desktop environment shuld be hinted that
* the window does not want to receive input focus. * 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 * 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 * Determines whether or not the desktop environment should be hinted that the
* window does not want to receive input focus when it is mapped. * 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. * it is mapped.
* *
* Since: 2.22 * 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. * 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 * Since: 2.22
*/ */
@ -6792,7 +6792,7 @@ gdk_window_is_input_only (GdkWindow *window)
* *
* Determines whether or not the window is shaped. * Determines whether or not the window is shaped.
* *
* Return value: %TRUE if @window is shaped * Returns: %TRUE if @window is shaped
* *
* Since: 2.22 * Since: 2.22
*/ */
@ -9413,7 +9413,7 @@ gdk_window_set_type_hint (GdkWindow *window,
* *
* This function returns the type hint set for a 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 * Since: 2.10
**/ **/
@ -9755,7 +9755,7 @@ gdk_window_set_event_compression (GdkWindow *window,
* *
* Get the current event compression setting for this 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 * 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(). * 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 * Since: 2.4
**/ **/
@ -10444,7 +10444,7 @@ gdk_window_get_drag_protocol (GdkWindow *window,
* *
* This function is called by the drag source. * This function is called by the drag source.
* *
* Return value: (transfer full): a newly created #GdkDragContext * Returns: (transfer full): a newly created #GdkDragContext
*/ */
GdkDragContext * GdkDragContext *
gdk_drag_begin (GdkWindow *window, gdk_drag_begin (GdkWindow *window,
@ -10470,7 +10470,7 @@ gdk_drag_begin (GdkWindow *window,
* *
* This function is called by the drag source. * This function is called by the drag source.
* *
* Return value: (transfer full): a newly created #GdkDragContext * Returns: (transfer full): a newly created #GdkDragContext
*/ */
GdkDragContext * GdkDragContext *
gdk_drag_begin_for_device (GdkWindow *window, gdk_drag_begin_for_device (GdkWindow *window,
@ -10789,7 +10789,7 @@ gdk_window_set_frame_clock (GdkWindow *window,
* window. * window.
* *
* Since: 3.8 * Since: 3.8
* Return value: (transfer none): the frame clock * Returns: (transfer none): the frame clock
*/ */
GdkFrameClock* GdkFrameClock*
gdk_window_get_frame_clock (GdkWindow *window) 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. * a configure event will be sent to the toplevel window.
* *
* Since: 3.10 * Since: 3.10
* Return value: the scale factor * Returns: the scale factor
*/ */
gint gint
gdk_window_get_scale_factor (GdkWindow *window) gdk_window_get_scale_factor (GdkWindow *window)

4
gdk/quartz/gdkeventloop-quartz.c
View File

@ -386,7 +386,7 @@ pollfds_equal (GPollFD *old_pollfds,
* timeout is used only to tell if the polling operation is blocking * timeout is used only to tell if the polling operation is blocking
* or non-blocking. * or non-blocking.
* *
* Return value: * Returns:
* -1: No file descriptors ready, began asynchronous poll * -1: No file descriptors ready, began asynchronous poll
* 0: No file descriptors ready, asynchronous poll not needed * 0: No file descriptors ready, asynchronous poll not needed
* > 0: Number of file descriptors ready * > 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. * 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 static int
select_thread_collect_poll (GPollFD *ufds, guint nfds) select_thread_collect_poll (GPollFD *ufds, guint nfds)

2
gdk/win32/gdkwindow-win32.c
View File

@ -3320,7 +3320,7 @@ gdk_win32_window_is_win32 (GdkWindow *window)
* *
* Gets a DC with the given drawable selected into it. * 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 * %NULL. If this function succeeded
* _gdk_win32_impl_release_dc() must be called * _gdk_win32_impl_release_dc() must be called
* release the DC when you are done using it. * release the DC when you are done using it.

4
gdk/x11/gdkcursor-x11.c
View File

@ -291,7 +291,7 @@ _gdk_x11_display_get_cursor_for_type (GdkDisplay *display,
* *
* Returns the display of a #GdkCursor. * Returns the display of a #GdkCursor.
* *
* Return value: (transfer none): an Xlib Display*. * Returns: (transfer none): an Xlib Display*.
**/ **/
Display * Display *
gdk_x11_cursor_get_xdisplay (GdkCursor *cursor) 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. * Returns the X cursor belonging to a #GdkCursor.
* *
* Return value: an Xlib Cursor. * Returns: an Xlib Cursor.
**/ **/
Cursor Cursor
gdk_x11_cursor_get_xcursor (GdkCursor *cursor) gdk_x11_cursor_get_xcursor (GdkCursor *cursor)

6
gdk/x11/gdkdisplay-x11.c
View File

@ -1950,7 +1950,7 @@ gdk_x11_display_finalize (GObject *object)
* *
* Find the #GdkDisplay corresponding to @xdisplay, if any exists. * 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 * 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, * Given the root window ID of one of the screen’s of a #GdkDisplay,
* finds the screen. * finds the screen.
* *
* Return value: (transfer none): the #GdkScreen corresponding to * Returns: (transfer none): the #GdkScreen corresponding to
* @xrootwin, or %NULL. * @xrootwin, or %NULL.
**/ **/
GdkScreen * GdkScreen *
@ -2751,7 +2751,7 @@ gdk_x11_display_set_window_scale (GdkDisplay *display,
* *
* Since: 3.0 * Since: 3.0
* *
* Return value: X error code or 0 on success * Returns: X error code or 0 on success
*/ */
gint gint
gdk_x11_display_error_trap_pop (GdkDisplay *display) gdk_x11_display_error_trap_pop (GdkDisplay *display)

6
gdk/x11/gdkmain-x11.c
View File

@ -422,7 +422,7 @@ gdk_x11_ungrab_server (void)
* *
* Gets the default GTK+ screen number. * 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 * the --display command line option or the DISPLAY environment
* variable when gdk_init() calls XOpenDisplay(). * variable when gdk_init() calls XOpenDisplay().
**/ **/
@ -438,7 +438,7 @@ gdk_x11_get_default_screen (void)
* Gets the root window of the default screen * Gets the root window of the default screen
* (see gdk_x11_get_default_screen()). * (see gdk_x11_get_default_screen()).
* *
* Return value: an Xlib Window. * Returns: an Xlib Window.
**/ **/
Window Window
gdk_x11_get_default_root_xwindow (void) gdk_x11_get_default_root_xwindow (void)
@ -451,7 +451,7 @@ gdk_x11_get_default_root_xwindow (void)
* *
* Gets the default GTK+ display. * 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 * the display specified in the `--display` command
* line option or the `DISPLAY` environment variable. * line option or the `DISPLAY` environment variable.
**/ **/

16
gdk/x11/gdkproperty-x11.c
View File

@ -175,7 +175,7 @@ lookup_cached_xatom (GdkDisplay *display,
* with the same string value. The special value %GDK_NONE * with the same string value. The special value %GDK_NONE
* is converted to %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 * 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 * Converts from a #GdkAtom to the X atom for the default GDK display
* with the same string value. * with the same string value.
* *
* Return value: the X atom corresponding to @atom. * Returns: the X atom corresponding to @atom.
**/ **/
Atom Atom
gdk_x11_atom_to_xatom (GdkAtom 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 * Convert from an X atom for a #GdkDisplay to the corresponding
* #GdkAtom. * #GdkAtom.
* *
* Return value: (transfer none): the corresponding #GdkAtom. * Returns: (transfer none): the corresponding #GdkAtom.
* *
* Since: 2.2 * 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 * Convert from an X atom for the default display to the corresponding
* #GdkAtom. * #GdkAtom.
* *
* Return value: (transfer none): the corresponding G#dkAtom. * Returns: (transfer none): the corresponding G#dkAtom.
**/ **/
GdkAtom GdkAtom
gdk_x11_xatom_to_atom (Atom xatom) 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 * 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. * 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 * 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 * 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. * 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 Atom
gdk_x11_get_xatom_by_name (const gchar *atom_name) 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 * XAtomName() and gdk_atom_name(), the result doesn’t need to
* be freed. * 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. * so it shouldn’t be modifed or freed.
* *
* Since: 2.2 * 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, * doesn’t need to be freed. Also, this function will never return %NULL,
* even if @xatom is invalid. * 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. * so it shouldn’t be modifed or freed.
**/ **/
const gchar * const gchar *

4
gdk/x11/gdkscreen-x11.c
View File

@ -1554,7 +1554,7 @@ fetch_net_wm_check_window (GdkScreen *screen)
* You can monitor the window_manager_changed signal on #GdkScreen to detect * You can monitor the window_manager_changed signal on #GdkScreen to detect
* a window manager change. * a window manager change.
* *
* Return value: %TRUE if the window manager supports @property * Returns: %TRUE if the window manager supports @property
* *
* Since: 2.2 * 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. * 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 * "unknown" if the window manager is unknown. The string is owned by GDK
* and should not be freed. * and should not be freed.
* *

2
gdk/x11/gdkselection-x11.c
View File

@ -703,7 +703,7 @@ _gdk_x11_display_utf8_to_string_target (GdkDisplay *display,
* *
* Converts from UTF-8 to compound text. * Converts from UTF-8 to compound text.
* *
* Return value: %TRUE if the conversion succeeded, * Returns: %TRUE if the conversion succeeded,
* otherwise %FALSE * otherwise %FALSE
* *
* Since: 2.24 * Since: 2.24

2
gdk/x11/gdkvisual-x11.c
View File

@ -583,7 +583,7 @@ _gdk_visual_get_x11_colormap (GdkVisual *visual)
* *
* Returns the X visual belonging to a #GdkVisual. * Returns the X visual belonging to a #GdkVisual.
* *
* Return value: (transfer none): an Xlib Visual*. * Returns: (transfer none): an Xlib Visual*.
**/ **/
Visual * Visual *
gdk_x11_visual_get_xvisual (GdkVisual *visual) gdk_x11_visual_get_xvisual (GdkVisual *visual)

6
gdk/x11/gdkwindow-x11.c
View File

@ -1185,7 +1185,7 @@ x_event_mask_to_gdk_event_mask (long mask)
* was already known to GDK, a new reference to the existing * was already known to GDK, a new reference to the existing
* #GdkWindow is returned. * #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 * window, or %NULL if the window has been destroyed. The wrapper
* will be newly created, if one doesn’t exist already. * 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. * Routine to get the current X server time stamp.
* *
* Return value: the time stamp. * Returns: the time stamp.
**/ **/
guint32 guint32
gdk_x11_get_server_time (GdkWindow *window) 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. * 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 XID
gdk_x11_window_get_xid (GdkWindow *window) gdk_x11_window_get_xid (GdkWindow *window)

2
gdk/x11/gdkxid.c
View File

@ -85,7 +85,7 @@ _gdk_x11_display_remove_window (GdkDisplay *display,
* *
* Looks up the #GdkWindow that wraps the given native window handle. * 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. * window, or %NULL if there is none.
* *
* Since: 2.24 * Since: 2.24

16
gtk/deprecated/gtkaction.c
View File

@ -621,7 +621,7 @@ gtk_action_buildable_get_name (GtkBuildable *buildable)
* See the [UI Definition section][XML-UI] for information on allowed action * See the [UI Definition section][XML-UI] for information on allowed action
* names. * names.
* *
* Return value: a new #GtkAction * Returns: a new #GtkAction
* *
* Since: 2.4 * Since: 2.4
* *
@ -1105,7 +1105,7 @@ _gtk_action_remove_from_proxy_list (GtkAction *action,
* Returns the proxy widgets for an action. * Returns the proxy widgets for an action.
* See also gtk_activatable_get_related_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. * and must not be modified.
* *
* Since: 2.4 * Since: 2.4
@ -1126,7 +1126,7 @@ gtk_action_get_proxies (GtkAction *action)
* *
* Returns the name of the 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. * be freed.
* *
* Since: 2.4 * Since: 2.4
@ -1147,7 +1147,7 @@ gtk_action_get_name (GtkAction *action)
* *
* Returns whether the action is effectively sensitive. * 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. * are both sensitive.
* *
* Since: 2.4 * Since: 2.4
@ -1175,7 +1175,7 @@ gtk_action_is_sensitive (GtkAction *action)
* necessarily mean effective sensitivity. See gtk_action_is_sensitive() * necessarily mean effective sensitivity. See gtk_action_is_sensitive()
* for that. * for that.
* *
* Return value: %TRUE if the action itself is sensitive. * Returns: %TRUE if the action itself is sensitive.
* *
* Since: 2.4 * Since: 2.4
* *
@ -1227,7 +1227,7 @@ gtk_action_set_sensitive (GtkAction *action,
* *
* Returns whether the action is effectively visible. * 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. * are both visible.
* *
* Since: 2.4 * Since: 2.4
@ -1255,7 +1255,7 @@ gtk_action_is_visible (GtkAction *action)
* necessarily mean effective visibility. See gtk_action_is_sensitive() * necessarily mean effective visibility. See gtk_action_is_sensitive()
* for that. * for that.
* *
* Return value: %TRUE if the action itself is visible. * Returns: %TRUE if the action itself is visible.
* *
* Since: 2.4 * Since: 2.4
* *
@ -2060,7 +2060,7 @@ gtk_action_disconnect_accelerator (GtkAction *action)
* item or the toolbar item it creates, this function returns an * item or the toolbar item it creates, this function returns an
* instance of that menu. * 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. * action, or %NULL.
* *
* Since: 2.12 * Since: 2.12

4
gtk/deprecated/gtkactiongroup.c
View File

@ -672,7 +672,7 @@ gtk_action_group_get_name (GtkActionGroup *action_group)
* they are sensitive (see gtk_action_get_sensitive()) and their group * they are sensitive (see gtk_action_get_sensitive()) and their group
* is sensitive. * is sensitive.
* *
* Return value: %TRUE if the group is sensitive. * Returns: %TRUE if the group is sensitive.
* *
* Since: 2.4 * 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 * they are visible (see gtk_action_get_visible()) and their group
* is visible. * is visible.
* *
* Return value: %TRUE if the group is visible. * Returns: %TRUE if the group is visible.
* *
* Since: 2.4 * Since: 2.4
* *

18
gtk/deprecated/gtkcolorsel.c
View File

@ -2371,7 +2371,7 @@ default_change_palette_func (GdkScreen *screen,
* *
* Creates a new GtkColorSelection. * Creates a new GtkColorSelection.
* *
* Return value: a new #GtkColorSelection * Returns: a new #GtkColorSelection
*/ */
GtkWidget * GtkWidget *
gtk_color_selection_new (void) gtk_color_selection_new (void)
@ -2404,7 +2404,7 @@ gtk_color_selection_new (void)
* *
* Determines whether the colorsel has an opacity control. * 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 * %FALSE if it does't
*/ */
gboolean gboolean
@ -2464,7 +2464,7 @@ gtk_color_selection_set_has_opacity_control (GtkColorSelection *colorsel,
* *
* Determines whether the color selector has a color palette. * 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 gboolean
gtk_color_selection_get_has_palette (GtkColorSelection *colorsel) 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. * Returns the current alpha value.
* *
* Return value: an integer between 0 and 65535 * Returns: an integer between 0 and 65535
*/ */
guint16 guint16
gtk_color_selection_get_current_alpha (GtkColorSelection *colorsel) 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. * Returns the previous alpha value.
* *
* Return value: an integer between 0 and 65535 * Returns: an integer between 0 and 65535
*/ */
guint16 guint16
gtk_color_selection_get_previous_alpha (GtkColorSelection *colorsel) 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. * 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 * a color around, and %FALSE if the selection has stopped
*/ */
gboolean gboolean
@ -2937,7 +2937,7 @@ gtk_color_selection_is_adjusting (GtkColorSelection *colorsel)
* Parses a color palette string; the string is a colon-separated * Parses a color palette string; the string is a colon-separated
* list of color names readable by gdk_color_parse(). * 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 gboolean
gtk_color_selection_palette_from_string (const gchar *str, 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. * Encodes a palette as a string, useful for persistent storage.
* *
* Return value: allocated string encoding the palette * Returns: allocated string encoding the palette
*/ */
gchar* gchar*
gtk_color_selection_palette_to_string (const GdkColor *colors, 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 * the #GtkSettings:gtk-color-palette GtkSettings property so all
* GtkColorSelection widgets will be modified. * 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 * Since: 2.2
*/ */

36
gtk/deprecated/gtkfontsel.c
View File

@ -603,7 +603,7 @@ gtk_font_selection_init (GtkFontSelection *fontsel)
* *
* Creates a new #GtkFontSelection. * Creates a new #GtkFontSelection.
* *
* Return value: a new #GtkFontSelection * Returns: a new #GtkFontSelection
* *
* Deprecated: 3.2: Use #GtkFontChooserWidget instead * 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 * This returns the #GtkTreeView that lists font families, for
* example, “Sans”, “Serif”, etc. * 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 * 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 * This returns the #GtkTreeView which lists all styles available for
* the selected font. For example, “Regular”, “Bold”, etc. * 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 * 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 * 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. * 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 * Since: 2.14
* *
@ -1270,7 +1270,7 @@ gtk_font_selection_get_size_entry (GtkFontSelection *fontsel)
* *
* This returns the #GtkTreeView used to list font sizes. * 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 * 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. * 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 * Since: 2.14
* *
@ -1310,7 +1310,7 @@ gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel)
* *
* Gets the #PangoFontFamily representing the selected font family. * 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 * selected font family. Font families are a collection of font
* faces. The returned object is owned by @fontsel and must not * faces. The returned object is owned by @fontsel and must not
* be modified or freed. * be modified or freed.
@ -1334,7 +1334,7 @@ gtk_font_selection_get_family (GtkFontSelection *fontsel)
* Gets the #PangoFontFace representing the selected font group * Gets the #PangoFontFace representing the selected font group
* details (i.e. family, slant, weight, width, etc). * 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 * selected font group details. The returned object is owned by
* @fontsel and must not be modified or freed. * @fontsel and must not be modified or freed.
* *
@ -1356,7 +1356,7 @@ gtk_font_selection_get_face (GtkFontSelection *fontsel)
* *
* The selected font size. * 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. * or -1 if no font size is selected.
* *
* Since: 2.14 * Since: 2.14
@ -1384,7 +1384,7 @@ gtk_font_selection_get_size (GtkFontSelection *fontsel)
* “Helvetica Bold Italic 12”. Use pango_font_description_equal() * “Helvetica Bold Italic 12”. Use pango_font_description_equal()
* if you want to compare two font descriptions. * 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(). * no font is selected. You must free this string with g_free().
* *
* Deprecated: 3.2: Use #GtkFontChooser * 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 * 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. * @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 * such font exists or if the @fontsel doesn’t belong to a particular
* screen yet. * screen yet.
* *
@ -1563,7 +1563,7 @@ gtk_font_selection_set_font_name (GtkFontSelection *fontsel,
* *
* Gets the text displayed in the preview area. * 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 * This string is owned by the widget and should not be
* modified or freed * modified or freed
* *
@ -1717,7 +1717,7 @@ gtk_font_selection_dialog_init (GtkFontSelectionDialog *fontseldiag)
* *
* Creates a new #GtkFontSelectionDialog. * Creates a new #GtkFontSelectionDialog.
* *
* Return value: a new #GtkFontSelectionDialog * Returns: a new #GtkFontSelectionDialog
* *
* Deprecated: 3.2: Use #GtkFontChooserDialog * Deprecated: 3.2: Use #GtkFontChooserDialog
*/ */
@ -1761,7 +1761,7 @@ gtk_font_selection_dialog_get_font_selection (GtkFontSelectionDialog *fsd)
* *
* Gets the “OK” button. * 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. * for the “OK” button.
* *
* Since: 2.14 * Since: 2.14
@ -1782,7 +1782,7 @@ gtk_font_selection_dialog_get_ok_button (GtkFontSelectionDialog *fsd)
* *
* Gets the “Cancel” button. * 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. * for the “Cancel” button.
* *
* Since: 2.14 * 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() * to “Helvetica Bold Italic 12”. Use pango_font_description_equal()
* if you want to compare two font descriptions. * 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(). * font is selected. You must free this string with g_free().
* *
* Deprecated: 3.2: Use #GtkFontChooserDialog * Deprecated: 3.2: Use #GtkFontChooserDialog
@ -1862,7 +1862,7 @@ gtk_font_selection_dialog_get_font_name (GtkFontSelectionDialog *fsd)
* *
* Sets the currently selected font. * 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. * @fontname specified, %FALSE otherwise.
* *
* Deprecated: 3.2: Use #GtkFontChooserDialog * 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. * 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 * This string is owned by the widget and should not be
* modified or freed * modified or freed
* *

8
gtk/deprecated/gtkhandlebox.c
View File

@ -930,7 +930,7 @@ gtk_handle_box_set_shadow_type (GtkHandleBox *handle_box,
* Gets the type of shadow drawn around the handle box. See * Gets the type of shadow drawn around the handle box. See
* gtk_handle_box_set_shadow_type(). * 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. * 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 * Gets the handle position of the handle box. See
* gtk_handle_box_set_handle_position(). * gtk_handle_box_set_handle_position().
* *
* Return value: the current handle position. * Returns: the current handle position.
* *
* Deprecated: 3.4: #GtkHandleBox has been deprecated. * 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. * Gets the edge used for determining reattachment of the handle box.
* See gtk_handle_box_set_snap_edge(). * 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) * (GtkPositionType)-1 if this is determined (as per default)
* from the handle position. * 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. * 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 * Since: 2.14
* *

2
gtk/deprecated/gtkhscale.c
View File

@ -102,7 +102,7 @@ gtk_hscale_new (GtkAdjustment *adjustment)
* is a power of ten. If the resulting precision is not suitable for your * is a power of ten. If the resulting precision is not suitable for your
* needs, use gtk_scale_set_digits() to correct it. * 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 * Deprecated: 3.2: Use gtk_scale_new_with_range() with %GTK_ORIENTATION_HORIZONTAL instead
**/ **/

4
gtk/deprecated/gtkhsv.c
View File

@ -1209,7 +1209,7 @@ gtk_hsv_focus (GtkWidget *widget,
* *
* Creates a new HSV color selector. * Creates a new HSV color selector.
* *
* Return value: A newly-created HSV color selector. * Returns: A newly-created HSV color selector.
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1362,7 +1362,7 @@ gtk_hsv_get_metrics (GtkHSV *hsv,
* adjusting the value with the mouse. This function queries whether * adjusting the value with the mouse. This function queries whether
* the HSV color selector is being adjusted or not. * 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 * since they may be transitory, or %FALSE if they should consider
* the color value status to be final. * the color value status to be final.
* *

50
gtk/deprecated/gtkiconfactory.c
View File

@ -265,7 +265,7 @@ gtk_icon_factory_finalize (GObject *object)
* add a default icon factory with their icons, which will allow * add a default icon factory with their icons, which will allow
* themes to override the icons for the application. * themes to override the icons for the application.
* *
* Return value: a new #GtkIconFactory * Returns: a new #GtkIconFactory
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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 * widget that will display the icon, instead of using this
* function directly, so that themes are taken into account. * 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. * 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 * using this function directly, so that themes are taken into
* account. * account.
* *
* Return value: (transfer none): a #GtkIconSet, or %NULL * Returns: (transfer none): a #GtkIconSet, or %NULL
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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 * are free to render the pixbuf however they like, including changing
* the usual size. * the usual size.
* *
* Return value: %TRUE if @size was a valid size * Returns: %TRUE if @size was a valid size
* *
* Since: 2.2 * 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 * are free to render the pixbuf however they like, including changing
* the usual size. * the usual size.
* *
* Return value: %TRUE if @size was a valid size * Returns: %TRUE if @size was a valid size
*/ */
gboolean gboolean
gtk_icon_size_lookup (GtkIconSize size, 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. * 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. * 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 * #GtkIconSet is to create application-specific icon sets to place in
* a #GtkIconFactory. * a #GtkIconFactory.
* *
* Return value: a new #GtkIconSet * Returns: a new #GtkIconSet
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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 * using scaling, pixelation, etc. as required to adjust the icon size
* or make the icon look insensitive/prelighted. * or make the icon look insensitive/prelighted.
* *
* Return value: a new #GtkIconSet * Returns: a new #GtkIconSet
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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. * Increments the reference count on @icon_set.
* *
* Return value: @icon_set. * Returns: @icon_set.
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * Deprecated: 3.10: Use #GtkIconTheme instead.
*/ */
@ -1147,7 +1147,7 @@ G_DEFINE_BOXED_TYPE (GtkIconSet, gtk_icon_set,
* *
* Copies @icon_set by value. * 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. * 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 * (perhaps because an image file fails to load), a default "missing
* image" icon will be returned instead. * 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 * 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 * (perhaps because an image file fails to load), a default "missing
* image" icon will be returned instead. * 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 * 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 * (perhaps because an image file fails to load), a default "missing
* image" icon will be returned instead. * 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 * 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 * the icon source will be used as the base icon for any desired text
* direction, widget state, or icon size. * direction, widget state, or icon size.
* *
* Return value: a new #GtkIconSource * Returns: a new #GtkIconSource
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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. * 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. * 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 * filename is not a copy, and should not be modified or expected to
* persist beyond the lifetime of the icon source. * 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. * be modified or freed.
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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 * icon_name is not a copy, and should not be modified or expected to
* persist beyond the lifetime of the icon source. * 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. * 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 * virtual function. The reference count on the pixbuf is
* not incremented. * not incremented.
* *
* Return value: (transfer none): source pixbuf * Returns: (transfer none): source pixbuf
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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(). * 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. * 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(). * 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. * 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(). * 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. * 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 * value is only useful/meaningful if the text direction is not
* wildcarded. * wildcarded.
* *
* Return value: text direction this source matches * Returns: text direction this source matches
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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 * value is only useful/meaningful if the widget state is not
* wildcarded. * wildcarded.
* *
* Return value: widget state this source matches * Returns: widget state this source matches
* *
* Deprecated: 3.10: Use #GtkIconTheme instead. * 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 * Obtains the icon size this source applies to. The return value
* is only useful/meaningful if the icon size is not wildcarded. * 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. * 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 strings in the returned list aren’t copied.
* The list itself should be freed. * 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. * Deprecated: 3.10: Use #GtkIconTheme instead.
*/ */

2
gtk/deprecated/gtkimagemenuitem.c
View File

@ -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. * Gets the widget that is currently set as the image of @image_menu_item.
* See gtk_image_menu_item_set_image(). * 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 * Deprecated: 3.10
**/ **/

4
gtk/deprecated/gtkradioaction.c
View File

@ -208,7 +208,7 @@ gtk_radio_action_init (GtkRadioAction *action)
* a #GtkActionGroup and set the accelerator for the action, * a #GtkActionGroup and set the accelerator for the action,
* call gtk_action_group_add_action_with_accel(). * call gtk_action_group_add_action_with_accel().
* *
* Return value: a new #GtkRadioAction * Returns: a new #GtkRadioAction
* *
* Since: 2.4 * Since: 2.4
* *
@ -544,7 +544,7 @@ gtk_radio_action_join_group (GtkRadioAction *action,
* Obtains the value property of the currently active member of * Obtains the value property of the currently active member of
* the group to which @action belongs. * 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 * Since: 2.4
* *

14
gtk/deprecated/gtkrc.c
View File

@ -948,7 +948,7 @@ gtk_rc_set_default_files (gchar **filenames)
* Retrieves the current list of RC files that will be parsed * Retrieves the current list of RC files that will be parsed
* at the end of gtk_init(). * 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 * A %NULL-terminated array of filenames. This memory is owned
* by GTK+ and must not be freed by the application. If you want * by GTK+ and must not be freed by the application. If you want
* to store this information, you should make a copy. * 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 * will correctly copy an RC style that is a member of a class
* derived from #GtkRcStyle. * derived from #GtkRcStyle.
* *
* Return value: (transfer full): the resulting #GtkRcStyle * Returns: (transfer full): the resulting #GtkRcStyle
* *
* Deprecated: 3.0: Use #GtkCssProvider instead. * 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 * for the given #GtkSettings has changed, discard all style information
* and then reread all previously read RC files. * 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. * 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 * default #GtkSettings has changed, discard all style information
* and then reread all previously read RC files. * 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. * Deprecated: 3.0: Use #GtkCssProvider instead.
**/ **/
@ -1409,7 +1409,7 @@ gtk_rc_get_style (GtkWidget *widget)
* G_OBJECT_TYPE (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 * supplied paths, or %NULL if nothing matching was specified and the
* default style should be used. The returned value is owned by GTK+ * 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 * 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 * If the file is not found, it outputs a warning message using
* g_warning() and returns %NULL. * g_warning() and returns %NULL.
* *
* Return value: (type filename): the filename. * Returns: (type filename): the filename.
* *
* Deprecated: 3.0: Use #GtkCssProvider instead. * 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 * Searches for a theme engine in the GTK+ search path. This function
* is not useful for applications and should not be used. * 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. * freed with g_free()), otherwise %NULL.
* *
* Deprecated: 3.0: Use #GtkCssProvider instead. * Deprecated: 3.0: Use #GtkCssProvider instead.

6
gtk/deprecated/gtkrecentaction.c
View File

@ -688,7 +688,7 @@ gtk_recent_action_init (GtkRecentAction *action)
* a #GtkActionGroup and set the accelerator for the action, * a #GtkActionGroup and set the accelerator for the action,
* call gtk_action_group_add_action_with_accel(). * call gtk_action_group_add_action_with_accel().
* *
* Return value: the newly created #GtkRecentAction. * Returns: the newly created #GtkRecentAction.
* *
* Since: 2.12 * Since: 2.12
* *
@ -725,7 +725,7 @@ gtk_recent_action_new (const gchar *name,
* a #GtkActionGroup and set the accelerator for the action, * a #GtkActionGroup and set the accelerator for the action,
* call gtk_action_group_add_action_with_accel(). * call gtk_action_group_add_action_with_accel().
* *
* Return value: the newly created #GtkRecentAction * Returns: the newly created #GtkRecentAction
* *
* Since: 2.12 * 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(). * 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 * Since: 2.12
* *

6
gtk/deprecated/gtkstock.c
View File

@ -181,7 +181,7 @@ gtk_stock_add_static (const GtkStockItem *items,
* Fills @item with the registered values for @stock_id, returning %TRUE * Fills @item with the registered values for @stock_id, returning %TRUE
* if @stock_id was known. * if @stock_id was known.
* *
* Return value: %TRUE if @item was initialized * Returns: %TRUE if @item was initialized
* *
* Deprecated: 3.10 * 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(), * 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(). * 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 * 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. * 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 * Deprecated: 3.10
**/ **/

12
gtk/deprecated/gtkstyle.c
View File

@ -960,7 +960,7 @@ gtk_style_detach (GtkStyle *style)
* and the default icon factory, returning an icon set if found, * and the default icon factory, returning an icon set if found,
* otherwise %NULL. * 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 * 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 * it depends on the #GtkStyle and might change when a theme
* switch occurs. * switch occurs.
* *
* Return value: %TRUE if the mapping was found. * Returns: %TRUE if the mapping was found.
* *
* Since: 2.10 * 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 * according to the given parameters and returns the result in a
* pixbuf. * pixbuf.
* *
* Return value: (transfer full): a newly-created #GdkPixbuf * Returns: (transfer full): a newly-created #GdkPixbuf
* containing the rendered icon * containing the rendered icon
* *
* Deprecated:3.0: Use gtk_render_icon_pixbuf() instead * 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. * 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 * 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 * thus dropping any reference to the old modifier style. Add a reference
* to the modifier style if you want to keep it alive. * 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 * 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 * pointer to value this around, you must add a refcount using
* g_object_ref(). * g_object_ref().
@ -4749,7 +4749,7 @@ gtk_widget_class_path (GtkWidget *widget,
* the application and should not be modified. The pixbuf should be * the application and should not be modified. The pixbuf should be
* freed after use with g_object_unref(). * 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 * stock ID wasn’t known
* *
* Deprecated: 3.0: Use gtk_widget_render_icon_pixbuf() instead. * Deprecated: 3.0: Use gtk_widget_render_icon_pixbuf() instead.

10
gtk/deprecated/gtktable.c
View File

@ -866,7 +866,7 @@ gtk_table_set_row_spacing (GtkTable *table,
* Gets the amount of space between row @row, and * Gets the amount of space between row @row, and
* row @row + 1. See gtk_table_set_row_spacing(). * 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 * Deprecated: 3.4: #GtkGrid does not offer a replacement for this
* functionality. * functionality.
@ -929,7 +929,7 @@ gtk_table_set_col_spacing (GtkTable *table,
* Gets the amount of space between column @col, and * Gets the amount of space between column @col, and
* column @col + 1. See gtk_table_set_col_spacing(). * 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 * Deprecated: 3.4: #GtkGrid does not offer a replacement for this
* functionality. * functionality.
@ -987,7 +987,7 @@ gtk_table_set_row_spacings (GtkTable *table,
* the spacing that will be used for newly added rows. * the spacing that will be used for newly added rows.
* (See gtk_table_set_row_spacings()) * (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. * 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. * the spacing that will be used for newly added columns.
* (See gtk_table_set_col_spacings()) * (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. * 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 * Returns whether the table cells are all constrained to the same
* width and height. (See gtk_table_set_homogeneous ()) * 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 * Deprecated: 3.4: Use gtk_grid_get_row_homogeneous() and
* gtk_grid_get_column_homogeneous() with #GtkGrid. * gtk_grid_get_column_homogeneous() with #GtkGrid.

2
gtk/deprecated/gtktoggleaction.c
View File

@ -178,7 +178,7 @@ gtk_toggle_action_init (GtkToggleAction *action)
* a #GtkActionGroup and set the accelerator for the action, * a #GtkActionGroup and set the accelerator for the action,
* call gtk_action_group_add_action_with_accel(). * call gtk_action_group_add_action_with_accel().
* *
* Return value: a new #GtkToggleAction * Returns: a new #GtkToggleAction
* *
* Since: 2.4 * Since: 2.4
* *

24
gtk/deprecated/gtkuimanager.c
View File

@ -829,7 +829,7 @@ gtk_ui_manager_real_get_action (GtkUIManager *manager,
* *
* Creates a new ui manager object. * Creates a new ui manager object.
* *
* Return value: a new ui manager object. * Returns: a new ui manager object.
* *
* Since: 2.4 * Since: 2.4
* *
@ -849,7 +849,7 @@ gtk_ui_manager_new (void)
* Returns whether menus generated by this #GtkUIManager * Returns whether menus generated by this #GtkUIManager
* will have tearoff menu items. * will have tearoff menu items.
* *
* Return value: whether tearoff menu items are added * Returns: whether tearoff menu items are added
* *
* Since: 2.4 * Since: 2.4
* *
@ -1049,7 +1049,7 @@ gtk_ui_manager_remove_action_group (GtkUIManager *manager,
* *
* Returns the list of action groups associated with @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+ * action groups. The list is owned by GTK+
* and should not be modified. * and should not be modified.
* *
@ -1071,7 +1071,7 @@ gtk_ui_manager_get_action_groups (GtkUIManager *manager)
* *
* Returns the #GtkAccelGroup associated with @manager. * Returns the #GtkAccelGroup associated with @manager.
* *
* Return value: (transfer none): the #GtkAccelGroup. * Returns: (transfer none): the #GtkAccelGroup.
* *
* Since: 2.4 * 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 * function to some container or explicitly ref them, they will survive the
* destruction of the ui manager. * 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 * or %NULL if no widget was found
* *
* Since: 2.4 * Since: 2.4
@ -1163,7 +1163,7 @@ collect_toplevels (GNode *node,
* *
* Obtains a list of all toplevel widgets of the requested types. * 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(). * all toplevel widgets of the requested types. Free the returned list with g_slist_free().
* *
* Since: 2.4 * 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() * Looks up an action by following a path. See gtk_ui_manager_get_widget()
* for more information about paths. * 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. * or %NULL if no widget was found.
* *
* Since: 2.4 * Since: 2.4
@ -1413,7 +1413,7 @@ free_node (GNode *node)
* Returns an unused merge id, suitable for use with * Returns an unused merge id, suitable for use with
* gtk_ui_manager_add_ui(). * gtk_ui_manager_add_ui().
* *
* Return value: an unused merge id. * Returns: an unused merge id.
* *
* Since: 2.4 * 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 * the current contents of @manager. An enclosing <ui> element is added if
* it is missing. * 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, * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
* the return value is 0. * 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 * Parses a file containing a [UI definition][XML-UI] and
* merges it with the current contents of @manager. * 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, * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
* the return value is 0. * 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 * Parses a resource file containing a [UI definition][XML-UI] and
* merges it with the current contents of @manager. * 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, * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
* the return value is 0. * 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. * 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. * the merged UI.
* *
* Since: 2.4 * Since: 2.4

2
gtk/deprecated/gtkvscale.c
View File

@ -100,7 +100,7 @@ gtk_vscale_new (GtkAdjustment *adjustment)
* is a power of ten. If the resulting precision is not suitable for your * is a power of ten. If the resulting precision is not suitable for your
* needs, use gtk_scale_set_digits() to correct it. * 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 * Deprecated: 3.2: Use gtk_scale_new_with_range() with %GTK_ORIENTATION_VERTICAL instead
**/ **/

28
gtk/gtkaboutdialog.c
View File

@ -1003,7 +1003,7 @@ gtk_about_dialog_show (GtkWidget *widget)
* *
* Returns the program name displayed in the about dialog. * 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. * dialog and must not be modified.
* *
* Since: 2.12 * Since: 2.12
@ -1083,7 +1083,7 @@ gtk_about_dialog_set_program_name (GtkAboutDialog *about,
* *
* Returns the version string. * 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. * dialog and must not be modified.
* *
* Since: 2.6 * Since: 2.6
@ -1131,7 +1131,7 @@ gtk_about_dialog_set_version (GtkAboutDialog *about,
* *
* Returns the copyright string. * 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. * dialog and must not be modified.
* *
* Since: 2.6 * Since: 2.6
@ -1190,7 +1190,7 @@ gtk_about_dialog_set_copyright (GtkAboutDialog *about,
* *
* Returns the comments string. * 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. * dialog and must not be modified.
* *
* Since: 2.6 * Since: 2.6
@ -1247,7 +1247,7 @@ gtk_about_dialog_set_comments (GtkAboutDialog *about,
* *
* Returns the license information. * 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. * dialog and must not be modified.
* *
* Since: 2.6 * Since: 2.6
@ -1358,7 +1358,7 @@ gtk_about_dialog_set_wrap_license (GtkAboutDialog *about,
* *
* Returns the website URL. * 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. * dialog and must not be modified.
* *
* Since: 2.6 * Since: 2.6
@ -1410,7 +1410,7 @@ gtk_about_dialog_set_website (GtkAboutDialog *about,
* *
* Returns the label used for the website link. * 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. * owned by the about dialog and must not be modified.
* *
* Since: 2.6 * 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 * Returns the string which are displayed in the authors tab
* of the secondary credits dialog. * 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 * %NULL-terminated string array containing the authors. The array is
* owned by the about dialog and must not be modified. * 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 * Returns the string which are displayed in the documenters
* tab of the secondary credits dialog. * 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 * %NULL-terminated string array containing the documenters. The
* array is owned by the about dialog and must not be modified. * 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 * Returns the string which are displayed in the artists tab
* of the secondary credits dialog. * 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 * %NULL-terminated string array containing the artists. The array is
* owned by the about dialog and must not be modified. * 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 * Returns the translator credits string which is displayed
* in the translators tab of the secondary credits dialog. * 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. * owned by the about dialog and must not be modified.
* *
* Since: 2.6 * 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. * 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 * 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. * 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. * 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 * owned by the dialog. If you want to keep a reference
* to it, you have to call g_strdup() on it. * 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() * Retrieves the license set using gtk_about_dialog_set_license_type()
* *
* Return value: a #GtkLicense value * Returns: a #GtkLicense value
* *
* Since: 3.0 * Since: 3.0
*/ */

2
gtk/gtkaccelmap.c
View File

@ -1032,7 +1032,7 @@ gtk_accel_map_init (GtkAccelMap *accel_map)
* map via the ::changed signal; it isn’t a parameter to the * map via the ::changed signal; it isn’t a parameter to the
* other accelerator map functions. * other accelerator map functions.
* *
* Return value: (transfer none): the global #GtkAccelMap object * Returns: (transfer none): the global #GtkAccelMap object
* *
* Since: 2.4 * Since: 2.4
**/ **/

2
gtk/gtkactionbar.c
View File

@ -367,7 +367,7 @@ gtk_action_bar_set_center_widget (GtkActionBar *action_bar,
* *
* Retrieves the center bar widget of the 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 * Since: 3.12
*/ */

12
gtk/gtkadjustment.c
View File

@ -394,7 +394,7 @@ gtk_adjustment_new (gdouble value,
* Gets the current value of the adjustment. See * Gets the current value of the adjustment. See
* gtk_adjustment_set_value (). * gtk_adjustment_set_value ().
* *
* Return value: The current value of the adjustment. * Returns: The current value of the adjustment.
**/ **/
gdouble gdouble
gtk_adjustment_get_value (GtkAdjustment *adjustment) gtk_adjustment_get_value (GtkAdjustment *adjustment)
@ -446,7 +446,7 @@ gtk_adjustment_set_value (GtkAdjustment *adjustment,
* *
* Retrieves the minimum value of the 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 * Since: 2.14
**/ **/
@ -495,7 +495,7 @@ gtk_adjustment_set_lower (GtkAdjustment *adjustment,
* *
* Retrieves the maximum value of the 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 * Since: 2.14
**/ **/
@ -540,7 +540,7 @@ gtk_adjustment_set_upper (GtkAdjustment *adjustment,
* *
* Retrieves the step increment of the 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 * Since: 2.14
**/ **/
@ -581,7 +581,7 @@ gtk_adjustment_set_step_increment (GtkAdjustment *adjustment,
* *
* Retrieves the page increment of the 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 * Since: 2.14
**/ **/
@ -622,7 +622,7 @@ gtk_adjustment_set_page_increment (GtkAdjustment *adjustment,
* *
* Retrieves the page size of the 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 * Since: 2.14
**/ **/

24
gtk/gtkassistant.c
View File

@ -1457,7 +1457,7 @@ gtk_assistant_remove (GtkContainer *container,
* *
* Creates a new #GtkAssistant. * Creates a new #GtkAssistant.
* *
* Return value: a newly created #GtkAssistant * Returns: a newly created #GtkAssistant
* *
* Since: 2.10 * Since: 2.10
*/ */
@ -1477,7 +1477,7 @@ gtk_assistant_new (void)
* *
* Returns the page number of the current page. * 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, * page in the @assistant, or -1 if the @assistant has no pages,
* or no current page. * or no current page.
* *
@ -1622,7 +1622,7 @@ gtk_assistant_previous_page (GtkAssistant *assistant)
* *
* Returns the number of pages in the @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 * Since: 2.10
*/ */
@ -1646,7 +1646,7 @@ gtk_assistant_get_n_pages (GtkAssistant *assistant)
* *
* Returns the child widget contained in page number @page_num. * 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 * if @page_num is out of bounds
* *
* Since: 2.10 * Since: 2.10
@ -1684,7 +1684,7 @@ gtk_assistant_get_nth_page (GtkAssistant *assistant,
* *
* Prepends a page to the @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 * Since: 2.10
*/ */
@ -1705,7 +1705,7 @@ gtk_assistant_prepend_page (GtkAssistant *assistant,
* *
* Appends a page to the @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 * Since: 2.10
*/ */
@ -1728,7 +1728,7 @@ gtk_assistant_append_page (GtkAssistant *assistant,
* *
* Inserts a page in the @assistant at a given position. * 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 * Since: 2.10
*/ */
@ -2000,7 +2000,7 @@ gtk_assistant_set_page_title (GtkAssistant *assistant,
* *
* Gets the title for @page. * Gets the title for @page.
* *
* Return value: the title for @page * Returns: the title for @page
* *
* Since: 2.10 * Since: 2.10
*/ */
@ -2079,7 +2079,7 @@ gtk_assistant_set_page_type (GtkAssistant *assistant,
* *
* Gets the page type of @page. * Gets the page type of @page.
* *
* Return value: the page type of @page * Returns: the page type of @page
* *
* Since: 2.10 * Since: 2.10
*/ */
@ -2163,7 +2163,7 @@ gtk_assistant_do_set_page_header_image (GtkAssistant *assistant,
* *
* Gets the header image for @page. * 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 * or %NULL if there’s no header image for the page
* *
* Since: 2.10 * Since: 2.10
@ -2254,7 +2254,7 @@ gtk_assistant_do_set_page_side_image (GtkAssistant *assistant,
* *
* Gets the side image for @page. * 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 * or %NULL if there’s no side image for the page
* *
* Since: 2.10 * Since: 2.10
@ -2332,7 +2332,7 @@ gtk_assistant_set_page_complete (GtkAssistant *assistant,
* *
* Gets whether @page is complete. * Gets whether @page is complete.
* *
* Return value: %TRUE if @page is complete. * Returns: %TRUE if @page is complete.
* *
* Since: 2.10 * Since: 2.10
*/ */

4
gtk/gtkbbox.c
View File

@ -395,7 +395,7 @@ gtk_button_box_get_layout (GtkButtonBox *widget)
* *
* Returns whether @child should appear in a secondary group of children. * 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 * Since: 2.4
**/ **/
@ -1136,7 +1136,7 @@ gtk_button_box_size_allocate (GtkWidget *widget,
* *
* Creates a new #GtkButtonBox. * Creates a new #GtkButtonBox.
* *
* Return value: a new #GtkButtonBox. * Returns: a new #GtkButtonBox.
* *
* Since: 3.0 * Since: 3.0
*/ */

2
gtk/gtkbin.c
View File

@ -321,7 +321,7 @@ gtk_bin_size_allocate (GtkWidget *widget,
* no child widget. The returned widget does not have a reference * no child widget. The returned widget does not have a reference
* added, so you do not need to unref it. * 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* GtkWidget*
gtk_bin_get_child (GtkBin *bin) gtk_bin_get_child (GtkBin *bin)

12
gtk/gtkbindings.c
View File

@ -684,7 +684,7 @@ gtk_binding_entry_activate (GtkBindingEntry *entry,
* GTK+ maintains a global list of binding sets. Each binding set has * GTK+ maintains a global list of binding sets. Each binding set has
* a unique name which needs to be specified upon creation. * a unique name which needs to be specified upon creation.
* *
* Return value: (transfer full): new binding set * Returns: (transfer full): new binding set
*/ */
GtkBindingSet* GtkBindingSet*
gtk_binding_set_new (const gchar *set_name) 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 * the passed in class structure. New binding sets are created on
* demand by this function. * demand by this function.
* *
* Return value: (transfer full): the binding set corresponding to * Returns: (transfer full): the binding set corresponding to
* @object_class * @object_class
*/ */
GtkBindingSet* 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() * 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(). * 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* GtkBindingSet*
gtk_binding_set_find (const gchar *set_name) 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 * Find a key binding matching @keyval and @modifiers within
* @binding_set and activate the binding on @object. * @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 gboolean
gtk_binding_set_activate (GtkBindingSet *binding_set, 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 * Find a key binding matching @keyval and @modifiers and activate the
* binding on @object. * binding on @object.
* *
* Return value: %TRUE if a binding was found and activated * Returns: %TRUE if a binding was found and activated
*/ */
gboolean gboolean
gtk_bindings_activate (GObject *object, gtk_bindings_activate (GObject *object,
@ -1644,7 +1644,7 @@ gtk_bindings_activate (GObject *object,
* Looks up key bindings for @object to find one matching * Looks up key bindings for @object to find one matching
* @event, and if one was found, activate it. * @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 * Since: 2.4
*/ */

10
gtk/gtkbox.c
View File

@ -2000,7 +2000,7 @@ gtk_box_get_preferred_height_for_width (GtkWidget *widget,
* *
* Creates a new #GtkBox. * Creates a new #GtkBox.
* *
* Return value: a new #GtkBox. * Returns: a new #GtkBox.
* *
* Since: 3.0 * Since: 3.0
**/ **/
@ -2113,7 +2113,7 @@ gtk_box_set_homogeneous (GtkBox *box,
* Returns whether the box is homogeneous (all children are the * Returns whether the box is homogeneous (all children are the
* same size). See gtk_box_set_homogeneous(). * same size). See gtk_box_set_homogeneous().
* *
* Return value: %TRUE if the box is homogeneous. * Returns: %TRUE if the box is homogeneous.
**/ **/
gboolean gboolean
gtk_box_get_homogeneous (GtkBox *box) 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(). * Gets the value set by gtk_box_set_spacing().
* *
* Return value: spacing between children * Returns: spacing between children
**/ **/
gint gint
gtk_box_get_spacing (GtkBox *box) 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(). * Gets the value set by gtk_box_set_baseline_position().
* *
* Return value: the baseline position * Returns: the baseline position
* *
* Since: 3.10 * Since: 3.10
**/ **/
@ -2614,7 +2614,7 @@ gtk_box_set_center_widget (GtkBox *box,
* *
* Retrieves the center widget of the box. * Retrieves the center widget of the box.
* *
* Return value: the center widget * Returns: the center widget
* *
* Since: 3.12 * Since: 3.12
*/ */

8
gtk/gtkbuilder.c
View File

@ -928,7 +928,7 @@ _gtk_builder_finish (GtkBuilder *builder)
* Most users will probably want to use gtk_builder_new_from_file(), * Most users will probably want to use gtk_builder_new_from_file(),
* gtk_builder_new_from_resource() or gtk_builder_new_from_string(). * 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 * 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 * Gets the object named @name. Note that this function does not
* increment the reference count of the returned object. * 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. * it could not be found in the object tree.
* *
* Since: 2.12 * 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 * this function does not increment the reference counts of the returned
* objects. * 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 * constructed by the #GtkBuilder instance. It should be freed by
* g_slist_free() * g_slist_free()
* *
@ -1471,7 +1471,7 @@ gtk_builder_set_translation_domain (GtkBuilder *builder,
* *
* Gets the translation domain of @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. * by the builder object and must not be modified or freed.
* *
* Since: 2.12 * Since: 2.12

14
gtk/gtkbutton.c
View File

@ -2345,7 +2345,7 @@ gtk_button_set_label (GtkButton *button,
* case if you create an empty button with gtk_button_new() to * case if you create an empty button with gtk_button_new() to
* use as a container. * 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. * by the widget and must not be modified or freed.
**/ **/
const gchar * const gchar *
@ -2393,7 +2393,7 @@ gtk_button_set_use_underline (GtkButton *button,
* Returns whether an embedded underline in the button label indicates a * Returns whether an embedded underline in the button label indicates a
* mnemonic. See gtk_button_set_use_underline (). * 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. * indicates the mnemonic accelerator keys.
**/ **/
gboolean gboolean
@ -2442,7 +2442,7 @@ gtk_button_set_use_stock (GtkButton *button,
* *
* Returns whether the button label is a stock item. * 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 * select a stock item instead of being
* used directly as the label text. * 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. * Returns whether the button grabs focus when it is clicked with the mouse.
* See gtk_button_set_focus_on_click(). * 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. * the mouse.
* *
* Since: 2.4 * Since: 2.4
@ -2771,7 +2771,7 @@ gtk_button_set_image (GtkButton *button,
* This may have been explicitly set by gtk_button_set_image() * This may have been explicitly set by gtk_button_set_image()
* or constructed by gtk_button_new_from_stock(). * 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 * Since: 2.6
*/ */
@ -2821,7 +2821,7 @@ gtk_button_set_image_position (GtkButton *button,
* Gets the position of the image relative to the text * Gets the position of the image relative to the text
* inside the button. * inside the button.
* *
* Return value: the position * Returns: the position
* *
* Since: 2.10 * 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. * Returns the button’s event window if it is realized, %NULL otherwise.
* This function should be rarely needed. * This function should be rarely needed.
* *
* Return value: (transfer none): @button’s event window. * Returns: (transfer none): @button’s event window.
* *
* Since: 2.22 * Since: 2.22
*/ */

8
gtk/gtkcalendar.c
View File

@ -3546,7 +3546,7 @@ gtk_calendar_drag_data_received (GtkWidget *widget,
* *
* Creates a new calendar, with the current date being selected. * Creates a new calendar, with the current date being selected.
* *
* Return value: a newly #GtkCalendar widget * Returns: a newly #GtkCalendar widget
**/ **/
GtkWidget* GtkWidget*
gtk_calendar_new (void) gtk_calendar_new (void)
@ -3560,7 +3560,7 @@ gtk_calendar_new (void)
* *
* Returns the current display options of @calendar. * Returns the current display options of @calendar.
* *
* Return value: the display options. * Returns: the display options.
* *
* Since: 2.4 * Since: 2.4
**/ **/
@ -3996,7 +3996,7 @@ gtk_calendar_set_detail_height_rows (GtkCalendar *calendar,
* *
* Since: 2.14 * Since: 2.14
* *
* Return value: The width of detail cells, in characters. * Returns: The width of detail cells, in characters.
*/ */
gint gint
gtk_calendar_get_detail_width_chars (GtkCalendar *calendar) gtk_calendar_get_detail_width_chars (GtkCalendar *calendar)
@ -4015,7 +4015,7 @@ gtk_calendar_get_detail_width_chars (GtkCalendar *calendar)
* *
* Since: 2.14 * Since: 2.14
* *
* Return value: The height of detail cells, in rows. * Returns: The height of detail cells, in rows.
*/ */
gint gint
gtk_calendar_get_detail_height_rows (GtkCalendar *calendar) gtk_calendar_get_detail_height_rows (GtkCalendar *calendar)

2
gtk/gtkcalendar.h
View File

@ -86,7 +86,7 @@ typedef enum
* *
* Since: 2.14 * 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. * for the specified day, or %NULL.
*/ */
typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar, typedef gchar* (*GtkCalendarDetailFunc) (GtkCalendar *calendar,

38
gtk/gtkcellarea.c
View File

@ -1701,7 +1701,7 @@ get_has_renderer (GtkCellRenderer *renderer,
* *
* Checks if @area contains @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 * Since: 3.0
*/ */
@ -1786,7 +1786,7 @@ gtk_cell_area_foreach_alloc (GtkCellArea *area,
* *
* Delegates event handling to a #GtkCellArea. * 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 * 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 * Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
* returns the full cell allocation for it inside @cell_area. * 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 * 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 * one should render and handle events with the same #GtkCellAreaContext
* which was used to request the size of those rows of data). * 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 * 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 * was already used to request all the row widths that are
* to be displayed. * 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 * Since: 3.0
*/ */
@ -2036,7 +2036,7 @@ gtk_cell_area_copy_context (GtkCellArea *area,
* Gets whether the area prefers a height-for-width layout * Gets whether the area prefers a height-for-width layout
* or a width-for-height layout. * or a width-for-height layout.
* *
* Return value: The #GtkSizeRequestMode preferred by @area. * Returns: The #GtkSizeRequestMode preferred by @area.
* *
* Since: 3.0 * Since: 3.0
*/ */
@ -2357,7 +2357,7 @@ gtk_cell_area_apply_attributes (GtkCellArea *area,
* used to interact with renderers from #GtkCellArea * used to interact with renderers from #GtkCellArea
* subclasses. * 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 * attributes applied to @area. This string belongs to the area and
* should not be freed. * 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. * 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. * or %NULL if @aclass has no child property with that name.
* *
* Since: 3.0 * 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. * 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 * allocated %NULL-terminated array of #GParamSpec*. The array
* must be freed with g_free(). * 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, * Returns whether the area can do anything when activated,
* after applying new attributes to @area. * 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 * 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 * method to receive and navigate focus in its own way particular
* to how it lays out cells. * 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 * Since: 3.0
*/ */
@ -2904,7 +2904,7 @@ gtk_cell_area_focus (GtkCellArea *area,
* cell, however some subclasses which embed widgets in the area * cell, however some subclasses which embed widgets in the area
* can also activate a widget if it currently has the focus. * 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 * Since: 3.0
*/ */
@ -2974,7 +2974,7 @@ gtk_cell_area_set_focus_cell (GtkCellArea *area,
* *
* Retrieves the currently focused cell for @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 * 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 * Returns whether @sibling is one of @renderer’s focus siblings
* (see gtk_cell_area_add_focus_sibling()). * (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 * Since: 3.0
*/ */
@ -3128,7 +3128,7 @@ gtk_cell_area_is_focus_sibling (GtkCellArea *area,
* *
* Gets the focus sibling cell renderers for @renderer. * 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. * The returned list is internal and should not be freed.
* *
* Since: 3.0 * 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 * then chose to activate the focus cell for which the event
* cell may have been a sibling. * 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. * is a sibling, or %NULL.
* *
* Since: 3.0 * Since: 3.0
@ -3304,7 +3304,7 @@ gtk_cell_area_set_edit_widget (GtkCellArea *area,
* Gets the #GtkCellRenderer in @area that is currently * Gets the #GtkCellRenderer in @area that is currently
* being edited. * being edited.
* *
* Return value: (transfer none): The currently edited #GtkCellRenderer * Returns: (transfer none): The currently edited #GtkCellRenderer
* *
* Since: 3.0 * Since: 3.0
*/ */
@ -3327,7 +3327,7 @@ gtk_cell_area_get_edited_cell (GtkCellArea *area)
* Gets the #GtkCellEditable widget currently used * Gets the #GtkCellEditable widget currently used
* to edit the currently edited cell. * 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 * 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() * for keyboard events for free in its own GtkCellArea->activate()
* implementation. * implementation.
* *
* Return value: whether cell activation was successful * Returns: whether cell activation was successful
* *
* Since: 3.0 * Since: 3.0
*/ */

4
gtk/gtkcellarea.h
View File

@ -65,7 +65,7 @@ typedef struct _GtkCellAreaContext GtkCellAreaContext;
* The type of the callback functions used for iterating over * The type of the callback functions used for iterating over
* the cell renderers of a #GtkCellArea, see gtk_cell_area_foreach(). * 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, typedef gboolean (*GtkCellCallback) (GtkCellRenderer *renderer,
gpointer data); gpointer data);
@ -83,7 +83,7 @@ typedef gboolean (*GtkCellCallback) (GtkCellRenderer *renderer,
* cell renderers and their allocated areas inside a #GtkCellArea, * cell renderers and their allocated areas inside a #GtkCellArea,
* see gtk_cell_area_foreach_alloc(). * 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, typedef gboolean (*GtkCellAllocCallback) (GtkCellRenderer *renderer,
const GdkRectangle *cell_area, const GdkRectangle *cell_area,

4
gtk/gtkcellareabox.c
View File

@ -2117,7 +2117,7 @@ _gtk_cell_area_box_group_visible (GtkCellAreaBox *box,
* *
* Creates a new #GtkCellAreaBox. * Creates a new #GtkCellAreaBox.
* *
* Return value: a newly created #GtkCellAreaBox * Returns: a newly created #GtkCellAreaBox
* *
* Since: 3.0 * Since: 3.0
*/ */
@ -2223,7 +2223,7 @@ gtk_cell_area_box_pack_end (GtkCellAreaBox *box,
* *
* Gets the spacing added between cell renderers. * 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 * Since: 3.0
*/ */

2
gtk/gtkcellareacontext.c
View File

@ -334,7 +334,7 @@ gtk_cell_area_context_real_allocate (GtkCellAreaContext *context,
* that the #GtkCellArea is configured with in order to * that the #GtkCellArea is configured with in order to
* compute a proper allocation. * 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 * Since: 3.0
*/ */

4
gtk/gtkcelllayout.c
View File

@ -577,7 +577,7 @@ gtk_cell_layout_reorder (GtkCellLayout *cell_layout,
* *
* Returns the cell renderers which have been added to @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 * a list of cell renderers. The list, but not the renderers has
* been newly allocated and should be freed with g_list_free() * been newly allocated and should be freed with g_list_free()
* when no longer needed. * 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 * if called on a #GtkCellArea or might be %NULL if no #GtkCellArea
* is used by @cell_layout. * 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 * Since: 3.0
*/ */

4
gtk/gtkcellrenderer.c
View File

@ -799,7 +799,7 @@ gtk_cell_renderer_render (GtkCellRenderer *cell,
* Some cell renderers may use events; for example, #GtkCellRendererToggle * Some cell renderers may use events; for example, #GtkCellRendererToggle
* toggles when it gets a mouse click. * 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 gboolean
gtk_cell_renderer_activate (GtkCellRenderer *cell, 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. * 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 * GtkCellEditable *
gtk_cell_renderer_start_editing (GtkCellRenderer *cell, gtk_cell_renderer_start_editing (GtkCellRenderer *cell,

2
gtk/gtkcellrendererpixbuf.c
View File

@ -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 * in the model, thus rendering a different image in each row of the
* #GtkTreeView. * #GtkTreeView.
* *
* Return value: the new cell renderer * Returns: the new cell renderer
**/ **/
GtkCellRenderer * GtkCellRenderer *
gtk_cell_renderer_pixbuf_new (void) gtk_cell_renderer_pixbuf_new (void)

2
gtk/gtkcellrendererprogress.c
View File

@ -257,7 +257,7 @@ gtk_cell_renderer_progress_init (GtkCellRendererProgress *cellprogress)
* *
* Creates a new #GtkCellRendererProgress. * Creates a new #GtkCellRendererProgress.
* *
* Return value: the new cell renderer * Returns: the new cell renderer
* *
* Since: 2.6 * Since: 2.6
**/ **/

2
gtk/gtkcellrendererspinner.c
View File

@ -176,7 +176,7 @@ gtk_cell_renderer_spinner_init (GtkCellRendererSpinner *cell)
* Returns a new cell renderer which will show a spinner to indicate * Returns a new cell renderer which will show a spinner to indicate
* activity. * activity.
* *
* Return value: a new #GtkCellRenderer * Returns: a new #GtkCellRenderer
* *
* Since: 2.20 * Since: 2.20
*/ */

2
gtk/gtkcellrenderertext.c
View File

@ -1553,7 +1553,7 @@ gtk_cell_renderer_text_set_property (GObject *object,
* value in the model, thus rendering a different string in each row * value in the model, thus rendering a different string in each row
* of the #GtkTreeView * of the #GtkTreeView
* *
* Return value: the new cell renderer * Returns: the new cell renderer
**/ **/
GtkCellRenderer * GtkCellRenderer *
gtk_cell_renderer_text_new (void) gtk_cell_renderer_text_new (void)

8
gtk/gtkcellrenderertoggle.c
View File

@ -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 * in the model, thus causing the check button to reflect the state of
* the model. * the model.
* *
* Return value: the new cell renderer * Returns: the new cell renderer
**/ **/
GtkCellRenderer * GtkCellRenderer *
gtk_cell_renderer_toggle_new (void) 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. * 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 gboolean
gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle) 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 * Returns whether the cell renderer is active. See
* gtk_cell_renderer_toggle_set_active(). * gtk_cell_renderer_toggle_set_active().
* *
* Return value: %TRUE if the cell renderer is active. * Returns: %TRUE if the cell renderer is active.
**/ **/
gboolean gboolean
gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle) 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 * Returns whether the cell renderer is activatable. See
* gtk_cell_renderer_toggle_set_activatable(). * 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 * Since: 2.18
**/ **/

16
gtk/gtkcellview.c
View File

@ -936,7 +936,7 @@ row_changed_cb (GtkTreeModel *model,
* *
* Creates a new #GtkCellView widget. * Creates a new #GtkCellView widget.
* *
* Return value: A newly created #GtkCellView widget. * Returns: A newly created #GtkCellView widget.
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -964,7 +964,7 @@ gtk_cell_view_new (void)
* in this way alignments with cellviews for other rows are * in this way alignments with cellviews for other rows are
* possible. * possible.
* *
* Return value: A newly created #GtkCellView widget. * Returns: A newly created #GtkCellView widget.
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -988,7 +988,7 @@ gtk_cell_view_new_with_context (GtkCellArea *area,
* Creates a new #GtkCellView widget, adds a #GtkCellRendererText * Creates a new #GtkCellView widget, adds a #GtkCellRendererText
* to it, and makes it show @text. * to it, and makes it show @text.
* *
* Return value: A newly created #GtkCellView widget. * Returns: A newly created #GtkCellView widget.
* *
* Since: 2.6 * 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 * to it, and makes it show @markup. The text can be
* marked up with the [Pango text markup language][PangoMarkupFormat]. * 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 * Since: 2.6
*/ */
@ -1053,7 +1053,7 @@ gtk_cell_view_new_with_markup (const gchar *markup)
* Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf * Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
* to it, and makes it show @pixbuf. * to it, and makes it show @pixbuf.
* *
* Return value: A newly created #GtkCellView widget. * Returns: A newly created #GtkCellView widget.
* *
* Since: 2.6 * 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 * Sets @requisition to the size needed by @cell_view to display
* the model row pointed to by @path. * the model row pointed to by @path.
* *
* Return value: %TRUE * Returns: %TRUE
* *
* Since: 2.6 * 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 * Gets whether @cell_view is configured to draw all of its
* cells in a sensitive state. * 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 * cells in a sensitive state
* *
* Since: 3.0 * 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 * Gets whether @cell_view is configured to request space
* to fit the entire #GtkTreeModel. * 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. * the entire #GtkTreeModel.
* *
* Since: 3.0 * Since: 3.0

6
gtk/gtkcheckmenuitem.c
View File

@ -339,7 +339,7 @@ gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
* Returns whether the check menu item is active. See * Returns whether the check menu item is active. See
* gtk_check_menu_item_set_active (). * gtk_check_menu_item_set_active ().
* *
* Return value: %TRUE if the menu item is checked. * Returns: %TRUE if the menu item is checked.
*/ */
gboolean gboolean
gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item) 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(). * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
* *
* Return value: %TRUE if inconsistent * Returns: %TRUE if inconsistent
**/ **/
gboolean gboolean
gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item) 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 * 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 * Since: 2.4
**/ **/

34
gtk/gtkclipboard.c
View File

@ -344,7 +344,7 @@ clipboard_display_closed (GdkDisplay *display,
* if your application called “Foo” has a special-purpose * if your application called “Foo” has a special-purpose
* clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”. * 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 * 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 * object has been created, it is persistent and, since it is owned by
* GTK+, must not be freed or unrefd. * 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. * Returns the clipboard object for the given selection.
* See gtk_clipboard_get_for_display() for complete details. * 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 * already exists, a new one will be created. Once a clipboard
* object has been created, it is persistent and, since it is * object has been created, it is persistent and, since it is
* owned by GTK+, must not be freed or unreffed. * 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 * a list of supported formats for the clipboard data and a function
* to call to get the actual data when it is requested. * 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 * If setting the clipboard data failed the provided callback
* functions will be ignored. * 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 * is that instead of an generic @user_data pointer, a #GObject is passed
* in. * 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 * If setting the clipboard data failed the provided callback
* functions will be ignored. * 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 * gtk_clipboard_clear() has not subsequently called, returns the owner set
* by gtk_clipboard_set_with_owner(). * 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. * otherwise %NULL.
**/ **/
GObject * GObject *
@ -1385,7 +1385,7 @@ clipboard_received_func (GtkClipboard *clipboard,
* This function waits for the data to be received using the main * This function waits for the data to be received using the main
* loop, so events, timeouts, etc, may be dispatched during the wait. * 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, * if retrieving the given target failed. If non-%NULL,
* this value must be freed with gtk_selection_data_free() * this value must be freed with gtk_selection_data_free()
* when you are finished with it. * 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, * the data to be received using the main loop, so events,
* timeouts, etc, may be dispatched during the wait. * 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 * be freed with g_free(), or %NULL if retrieving
* the selection data failed. (This could happen * the selection data failed. (This could happen
* for various reasons, in particular if the * 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, * waits for the data to be received using the main loop, so events,
* timeouts, etc, may be dispatched during the wait. * 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 * newly-allocated binary block of data which must be
* freed with g_free(), or %NULL if retrieving the * freed with g_free(), or %NULL if retrieving the
* selection data failed. (This could happen for various * 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, * the data to be received using the main loop, so events,
* timeouts, etc, may be dispatched during the wait. * 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 * object which must be disposed with g_object_unref(), or
* %NULL if retrieving the selection data failed. (This could * %NULL if retrieving the selection data failed. (This could
* happen for various reasons, in particular if the clipboard * 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, * for the data to be received using the main loop, so events,
* timeouts, etc, may be dispatched during the wait. * 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 * %NULL-terminated array of strings which must
* be freed with g_strfreev(), or %NULL if * be freed with g_strfreev(), or %NULL if
* retrieving the selection data failed. (This * retrieving the selection data failed. (This
@ -1660,7 +1660,7 @@ gtk_clipboard_wait_for_uris (GtkClipboard *clipboard)
* *
* Gets the #GdkDisplay associated with @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 * 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 * gtk_clipboard_wait_for_text() since it doesn’t need to retrieve
* the actual text. * the actual text.
* *
* Return value: %TRUE is there is text available, %FALSE otherwise. * Returns: %TRUE is there is text available, %FALSE otherwise.
**/ **/
gboolean gboolean
gtk_clipboard_wait_is_text_available (GtkClipboard *clipboard) 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 * gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve
* the actual text. * 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 * 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 * gtk_clipboard_wait_for_image() since it doesn’t need to retrieve
* the actual image data. * 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 * 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 * gtk_clipboard_wait_for_uris() since it doesn’t need to retrieve
* the actual URI data. * 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 * 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 * This function waits for the data to be received using the main
* loop, so events, timeouts, etc, may be dispatched during the wait. * 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. * otherwise %FALSE.
* *
* Since: 2.4 * 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 * If you want to see if there’s text available on the clipboard, use
* gtk_clipboard_wait_is_text_available () instead. * 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 * Since: 2.6
*/ */

2
gtk/gtkcolorbutton.c
View File

@ -707,7 +707,7 @@ gtk_color_button_get_color (GtkColorButton *button,
* *
* Returns the current alpha value. * Returns the current alpha value.
* *
* Return value: an integer between 0 and 65535 * Returns: an integer between 0 and 65535
* *
* Since: 2.4 * Since: 2.4
* *

2
gtk/gtkcolorchooserdialog.c
View File

@ -270,7 +270,7 @@ gtk_color_chooser_dialog_iface_init (GtkColorChooserInterface *iface)
* *
* Creates a new #GtkColorChooserDialog. * Creates a new #GtkColorChooserDialog.
* *
* Return value: a new #GtkColorChooserDialog * Returns: a new #GtkColorChooserDialog
* *
* Since: 3.4 * Since: 3.4
*/ */

36
gtk/gtkcombobox.c
View File

@ -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. * for the current GtkComboBox model.
* *
* Since: 3.4 * Since: 3.4
@ -3987,7 +3987,7 @@ gtk_combo_box_cell_layout_get_area (GtkCellLayout *cell_layout)
* *
* Creates a new empty #GtkComboBox. * Creates a new empty #GtkComboBox.
* *
* Return value: A new #GtkComboBox. * Returns: A new #GtkComboBox.
* *
* Since: 2.4 * Since: 2.4
*/ */
@ -4003,7 +4003,7 @@ gtk_combo_box_new (void)
* *
* Creates a new empty #GtkComboBox using @area to layout cells. * Creates a new empty #GtkComboBox using @area to layout cells.
* *
* Return value: A new #GtkComboBox. * Returns: A new #GtkComboBox.
*/ */
GtkWidget * GtkWidget *
gtk_combo_box_new_with_area (GtkCellArea *area) 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. * The new combo box will use @area to layout cells.
* *
* Return value: A new #GtkComboBox. * Returns: A new #GtkComboBox.
*/ */
GtkWidget * GtkWidget *
gtk_combo_box_new_with_area_and_entry (GtkCellArea *area) 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. * Creates a new empty #GtkComboBox with an entry.
* *
* Return value: A new #GtkComboBox. * Returns: A new #GtkComboBox.
* *
* Since: 2.24 * Since: 2.24
*/ */
@ -4052,7 +4052,7 @@ gtk_combo_box_new_with_entry (void)
* *
* Creates a new #GtkComboBox with the model initialized to @model. * Creates a new #GtkComboBox with the model initialized to @model.
* *
* Return value: A new #GtkComboBox. * Returns: A new #GtkComboBox.
* *
* Since: 2.4 * Since: 2.4
*/ */
@ -4075,7 +4075,7 @@ gtk_combo_box_new_with_model (GtkTreeModel *model)
* Creates a new empty #GtkComboBox with an entry * Creates a new empty #GtkComboBox with an entry
* and with the model initialized to @model. * and with the model initialized to @model.
* *
* Return value: A new #GtkComboBox * Returns: A new #GtkComboBox
* *
* Since: 2.24 * 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 * `gtk_tree_path_get_indices (path)[0]`, where
* `path` is the #GtkTreePath of the active item. * `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. * or -1 if there’s no active item.
* *
* Since: 2.4 * 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. * 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 * Since: 2.4
*/ */
@ -4544,7 +4544,7 @@ out:
* *
* Returns the #GtkTreeModel which is acting as data source for @combo_box. * 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. * during construction.
* *
* Since: 2.4 * Since: 2.4
@ -5015,7 +5015,7 @@ gtk_combo_box_start_editing (GtkCellEditable *cell_editable,
* *
* Gets the current value of the :add-tearoffs property. * 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 * Deprecated: 3.10
*/ */
@ -5209,7 +5209,7 @@ gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box)
* *
* Returns the current row separator function. * Returns the current row separator function.
* *
* Return value: the current row separator function. * Returns: the current row separator function.
* *
* Since: 2.6 * 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 * Returns whether the combo box sets the dropdown button
* sensitive or not when there are no items in the model. * 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 * is sensitive when the model is empty, %GTK_SENSITIVITY_OFF
* if the button is always insensitive or * if the button is always insensitive or
* %GTK_SENSITIVITY_AUTO if it is only sensitive as long as * %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. * 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 * 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 * Returns the column which @combo_box is using to get the strings
* from to display in the internal entry. * 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 * 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 * Returns whether the combo box grabs focus when it is clicked
* with the mouse. See gtk_combo_box_set_focus_on_click(). * 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. * clicked with the mouse.
* *
* Since: 2.6 * 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 * Returns the column which @combo_box is using to get string IDs
* for values from. * 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 * 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 * no row is active, or if the active row has a %NULL ID value, then %NULL
* is returned. * is returned.
* *
* Return value: the ID of the active row, or %NULL * Returns: the ID of the active row, or %NULL
* *
* Since: 3.0 * Since: 3.0
**/ **/

4
gtk/gtkcomboboxtext.c
View File

@ -313,7 +313,7 @@ gtk_combo_box_text_buildable_custom_finished (GtkBuildable *buildable,
* Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
* strings. * strings.
* *
* Return value: A new #GtkComboBoxText * Returns: A new #GtkComboBoxText
* *
* Since: 2.24 * Since: 2.24
*/ */
@ -330,7 +330,7 @@ gtk_combo_box_text_new (void)
* Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying * Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
* strings. The combo box created by this function has an entry. * strings. The combo box created by this function has an entry.
* *
* Return value: a new #GtkComboBoxText * Returns: a new #GtkComboBoxText
* *
* Since: 2.24 * Since: 2.24
*/ */

16
gtk/gtkcontainer.c
View File

@ -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 can be added, e.g. for a #GtkPaned which already has two
* children. * children.
* *
* Return value: a #GType. * Returns: a #GType.
**/ **/
GType GType
gtk_container_child_type (GtkContainer *container) 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 * Retrieves the border width of the container. See
* gtk_container_set_border_width(). * gtk_container_set_border_width().
* *
* Return value: the current border width * Returns: the current border width
**/ **/
guint guint
gtk_container_get_border_width (GtkContainer *container) 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 * Returns the resize mode for the container. See
* gtk_container_set_resize_mode (). * 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 * Deprecated: 3.12: Resize modes are deprecated. They aren’t necessary
* anymore since frame clocks and might introduce obscure bugs if * 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 * Returns the container’s non-internal children. See
* gtk_container_forall() for details on what constitutes an "internal" child. * 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* GList*
gtk_container_get_children (GtkContainer *container) 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 * Sorts @children in the correct order for focusing with
* direction type @direction. * 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 * with children that aren’t suitable for focusing in this direction
* removed. * removed.
**/ **/
@ -3122,7 +3122,7 @@ gtk_container_set_focus_chain (GtkContainer *container,
* of the children. In that case, GTK+ stores %NULL in * of the children. In that case, GTK+ stores %NULL in
* @focusable_widgets and returns %FALSE. * @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. * has been set explicitly.
**/ **/
gboolean gboolean
@ -3228,7 +3228,7 @@ gtk_container_set_focus_vadjustment (GtkContainer *container,
* Retrieves the vertical focus adjustment for the container. See * Retrieves the vertical focus adjustment for the container. See
* gtk_container_set_focus_vadjustment(). * 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. * none has been set.
**/ **/
GtkAdjustment * GtkAdjustment *
@ -3283,7 +3283,7 @@ gtk_container_set_focus_hadjustment (GtkContainer *container,
* Retrieves the horizontal focus adjustment for the container. See * Retrieves the horizontal focus adjustment for the container. See
* gtk_container_set_focus_hadjustment (). * 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. * none has been set.
**/ **/
GtkAdjustment * GtkAdjustment *

6
gtk/gtkdialog.c
View File

@ -875,7 +875,7 @@ gtk_dialog_new_empty (const gchar *title,
* NULL); * NULL);
* ]| * ]|
* *
* Return value: a new #GtkDialog * Returns: a new #GtkDialog
*/ */
GtkWidget* GtkWidget*
gtk_dialog_new_with_buttons (const gchar *title, 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 * dialog’s action area. The button widget is returned, but usually
* you don’t need it. * 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* GtkWidget*
gtk_dialog_add_button (GtkDialog *dialog, 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 * such as timeouts, IO channel watches, DND drops, etc, will
* be triggered during a gtk_dialog_run() call. * be triggered during a gtk_dialog_run() call.
* *
* Return value: response ID * Returns: response ID
**/ **/
gint gint
gtk_dialog_run (GtkDialog *dialog) gtk_dialog_run (GtkDialog *dialog)

16
gtk/gtkdnd.c
View File

@ -1154,7 +1154,7 @@ gtk_drag_get_data (GtkWidget *widget,
* *
* Determines the source widget for a drag. * 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. * within a single application, a pointer to the source widget.
* Otherwise, %NULL. * Otherwise, %NULL.
*/ */
@ -1498,7 +1498,7 @@ gtk_drag_dest_unset (GtkWidget *widget)
* Returns the list of targets this widget can accept from * Returns the list of targets this widget can accept from
* drag-and-drop. * drag-and-drop.
* *
* Return value: (transfer none): the #GtkTargetList, or %NULL if none * Returns: (transfer none): the #GtkTargetList, or %NULL if none
**/ **/
GtkTargetList* GtkTargetList*
gtk_drag_dest_get_target_list (GtkWidget *widget) 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 * Returns whether the widget has been configured to always
* emit #GtkWidget::drag-motion signals. * emit #GtkWidget::drag-motion signals.
* *
* Return Value: %TRUE if the widget always emits * Returns: %TRUE if the widget always emits
* #GtkWidget::drag-motion events * #GtkWidget::drag-motion events
* *
* Since: 2.10 * 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 * that case, they will have to implement a drag_motion handler that
* passes the correct target list to this function. * 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 * and the dest can accept, or %GDK_NONE
**/ **/
GdkAtom GdkAtom
@ -2694,7 +2694,7 @@ gtk_drag_begin_internal (GtkWidget *widget,
* (remember to free the event with gdk_event_free() when you are done). * (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. * 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 * 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 * This is equivalent to gtk_drag_begin_with_coordinates(), passing -1, -1
* as coordinates. * 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. * 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 * Gets the list of targets this widget can provide for
* drag-and-drop. * 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 * 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 * at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus
* should trigger the beginning of a drag-and-drop operation. * 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 gboolean
gtk_drag_check_threshold (GtkWidget *widget, gtk_drag_check_threshold (GtkWidget *widget,

8
gtk/gtkeditable.c
View File

@ -247,7 +247,7 @@ gtk_editable_delete_text (GtkEditable *editable,
* *
* Note that positions are specified in characters, not bytes. * 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 * string. This string is allocated by the #GtkEditable
* implementation and should be freed by the caller. * 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. * Note that this position is in characters, not in bytes.
* *
* Return value: the cursor position * Returns: the cursor position
*/ */
gint gint
gtk_editable_get_position (GtkEditable *editable) 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. * 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 gboolean
gtk_editable_get_selection_bounds (GtkEditable *editable, gtk_editable_get_selection_bounds (GtkEditable *editable,
@ -450,7 +450,7 @@ gtk_editable_set_editable (GtkEditable *editable,
* Retrieves whether @editable is editable. See * Retrieves whether @editable is editable. See
* gtk_editable_set_editable(). * gtk_editable_set_editable().
* *
* Return value: %TRUE if @editable is editable. * Returns: %TRUE if @editable is editable.
*/ */
gboolean gboolean
gtk_editable_get_editable (GtkEditable *editable) gtk_editable_get_editable (GtkEditable *editable)

50
gtk/gtkentry.c
View File

@ -6615,7 +6615,7 @@ gtk_entry_reset_im_context (GtkEntry *entry)
* and the default key event handling of the #GtkEntry. * and the default key event handling of the #GtkEntry.
* See gtk_text_view_reset_im_context() for an example of use. * 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 * Since: 2.22
*/ */
@ -7335,7 +7335,7 @@ gtk_entry_ensure_pixbuf (GtkEntry *entry,
* *
* Creates a new entry. * Creates a new entry.
* *
* Return value: a new #GtkEntry. * Returns: a new #GtkEntry.
*/ */
GtkWidget* GtkWidget*
gtk_entry_new (void) gtk_entry_new (void)
@ -7349,7 +7349,7 @@ gtk_entry_new (void)
* *
* Creates a new entry with the specified text buffer. * Creates a new entry with the specified text buffer.
* *
* Return value: a new #GtkEntry * Returns: a new #GtkEntry
* *
* Since: 2.18 * Since: 2.18
*/ */
@ -7583,7 +7583,7 @@ gtk_entry_set_visibility (GtkEntry *entry,
* Retrieves whether the text in @entry is visible. See * Retrieves whether the text in @entry is visible. See
* gtk_entry_set_visibility(). * gtk_entry_set_visibility().
* *
* Return value: %TRUE if the text is currently visible * Returns: %TRUE if the text is currently visible
**/ **/
gboolean gboolean
gtk_entry_get_visibility (GtkEntry *entry) 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 * Retrieves the character displayed in place of the real characters
* for entries with visibility set to false. See gtk_entry_set_invisible_char(). * 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. * show invisible text at all.
**/ **/
gunichar gunichar
@ -7715,7 +7715,7 @@ gtk_entry_set_overwrite_mode (GtkEntry *entry,
* *
* Gets the value set by gtk_entry_set_overwrite_mode(). * 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 * Since: 2.14
**/ **/
@ -7742,7 +7742,7 @@ gtk_entry_get_overwrite_mode (GtkEntry *entry)
* gtk_entry_buffer_get_text (buffer); * 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 * string. This string points to internally allocated
* storage in the widget and must not be freed, modified or * storage in the widget and must not be freed, modified or
* stored. * stored.
@ -7797,7 +7797,7 @@ gtk_entry_set_max_length (GtkEntry *entry,
* gtk_entry_buffer_get_max_length (buffer); * 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. * in #GtkEntry, or 0 if there is no maximum.
**/ **/
gint gint
@ -7823,7 +7823,7 @@ gtk_entry_get_max_length (GtkEntry *entry)
* gtk_entry_buffer_get_length (buffer); * 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. * in #GtkEntry, or 0 if there are none.
* *
* Since: 2.14 * Since: 2.14
@ -7875,7 +7875,7 @@ gtk_entry_set_activates_default (GtkEntry *entry,
* *
* Retrieves the value set by gtk_entry_set_activates_default(). * 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 gboolean
gtk_entry_get_activates_default (GtkEntry *entry) 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(). * 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 gint
gtk_entry_get_width_chars (GtkEntry *entry) 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. * Retrieves the desired maximum width of @entry, in characters.
* See gtk_entry_set_max_width_chars(). * 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 * Since: 3.12
*/ */
@ -8009,7 +8009,7 @@ gtk_entry_set_has_frame (GtkEntry *entry,
* *
* Gets the value set by gtk_entry_set_has_frame(). * 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 gboolean
gtk_entry_get_has_frame (GtkEntry *entry) 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 * This function returns the entry’s #GtkEntry:inner-border property. See
* gtk_entry_set_inner_border() for more information. * 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 * 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 * gtk_entry_text_index_to_layout_index() are needed to convert byte
* indices in the layout to byte indices in the entry contents. * 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* PangoLayout*
gtk_entry_get_layout (GtkEntry *entry) 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(), * entry’s #PangoLayout (returned by gtk_entry_get_layout(),
* with text retrieved via pango_layout_get_text()). * with text retrieved via pango_layout_get_text()).
* *
* Return value: byte index into the entry contents * Returns: byte index into the entry contents
**/ **/
gint gint
gtk_entry_layout_index_to_text_index (GtkEntry *entry, 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 * gtk_entry_get_layout()) to a position in the entry contents
* (returned by gtk_entry_get_text()). * (returned by gtk_entry_get_text()).
* *
* Return value: byte index into the entry layout text * Returns: byte index into the entry layout text
**/ **/
gint gint
gtk_entry_text_index_to_layout_index (GtkEntry *entry, 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(). * Gets the value set by gtk_entry_set_alignment().
* *
* Return value: the alignment * Returns: the alignment
* *
* Since: 2.4 * 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, * to store image data. If the icon has no image data,
* the return value will be %GTK_IMAGE_EMPTY. * the return value will be %GTK_IMAGE_EMPTY.
* *
* Return value: image representation being used * Returns: image representation being used
* *
* Since: 2.16 * Since: 2.16
**/ **/
@ -10200,7 +10200,7 @@ gtk_entry_set_completion (GtkEntry *entry,
* *
* Returns the auxiliary completion object currently in use by @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. * in use by @entry.
* *
* Since: 2.4 * Since: 2.4
@ -10258,7 +10258,7 @@ gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
* Retrieves the horizontal cursor adjustment for the entry. * Retrieves the horizontal cursor adjustment for the entry.
* See gtk_entry_set_cursor_hadjustment(). * 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. * if none has been set.
* *
* Since: 2.12 * 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. * Returns the current fraction of the task that’s been completed.
* See gtk_entry_set_progress_fraction(). * 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 * 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(). * 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 * Since: 2.16
*/ */
@ -10715,7 +10715,7 @@ gtk_entry_set_attributes (GtkEntry *entry,
* Gets the attribute list that was set on the entry using * Gets the attribute list that was set on the entry using
* gtk_entry_set_attributes(), if any. * 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. * if none was set.
* *
* Since: 3.6 * 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 * Gets the tabstops that were set on the entry using gtk_entry_set_tabs(), if
* any. * 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 * Since: 3.10
*/ */

10
gtk/gtkentrybuffer.c
View File

@ -436,7 +436,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass)
* *
* Optionally, specify initial text to set in the buffer. * Optionally, specify initial text to set in the buffer.
* *
* Return value: A new GtkEntryBuffer object. * Returns: A new GtkEntryBuffer object.
* *
* Since: 2.18 * Since: 2.18
**/ **/
@ -456,7 +456,7 @@ gtk_entry_buffer_new (const gchar *initial_chars,
* *
* Retrieves the length in characters of the buffer. * 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 * Since: 2.18
**/ **/
@ -480,7 +480,7 @@ gtk_entry_buffer_get_length (GtkEntryBuffer *buffer)
* Retrieves the length in bytes of the buffer. * Retrieves the length in bytes of the buffer.
* See gtk_entry_buffer_get_length(). * See gtk_entry_buffer_get_length().
* *
* Return value: The byte length of the buffer. * Returns: The byte length of the buffer.
* *
* Since: 2.18 * Since: 2.18
**/ **/
@ -508,7 +508,7 @@ gtk_entry_buffer_get_bytes (GtkEntryBuffer *buffer)
* The memory pointer returned by this call will not change * The memory pointer returned by this call will not change
* unless this object emits a signal, or is finalized. * 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 * string. This string points to internally allocated
* storage in the buffer and must not be freed, modified or * storage in the buffer and must not be freed, modified or
* stored. * stored.
@ -592,7 +592,7 @@ gtk_entry_buffer_set_max_length (GtkEntryBuffer *buffer,
* Retrieves the maximum allowed length of the text in * Retrieves the maximum allowed length of the text in
* @buffer. See gtk_entry_buffer_set_max_length(). * @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. * in #GtkEntryBuffer, or 0 if there is no maximum.
* *
* Since: 2.18 * Since: 2.18

26
gtk/gtkentrycompletion.c
View File

@ -235,7 +235,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
* the #GtkFileChooser inserts only the part of the prefix up to the * the #GtkFileChooser inserts only the part of the prefix up to the
* next '/'. * next '/'.
* *
* Return value: %TRUE if the signal has been handled * Returns: %TRUE if the signal has been handled
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -263,7 +263,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
* Note that @model is the model that was passed to * Note that @model is the model that was passed to
* gtk_entry_completion_set_model(). * 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 * Since: 2.4
*/ */
@ -292,7 +292,7 @@ gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
* Note that @model is the model that was passed to * Note that @model is the model that was passed to
* gtk_entry_completion_set_model(). * 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 * Since: 2.12
*/ */
@ -1139,7 +1139,7 @@ gtk_entry_completion_selection_changed (GtkTreeSelection *selection,
* *
* Creates a new #GtkEntryCompletion object. * Creates a new #GtkEntryCompletion object.
* *
* Return value: A newly created #GtkEntryCompletion object * Returns: A newly created #GtkEntryCompletion object
* *
* Since: 2.4 * Since: 2.4
*/ */
@ -1161,7 +1161,7 @@ gtk_entry_completion_new (void)
* specified @area to layout cells in the underlying * specified @area to layout cells in the underlying
* #GtkTreeViewColumn for the drop-down menu. * #GtkTreeViewColumn for the drop-down menu.
* *
* Return value: A newly created #GtkEntryCompletion object * Returns: A newly created #GtkEntryCompletion object
* *
* Since: 3.0 * Since: 3.0
*/ */
@ -1181,7 +1181,7 @@ gtk_entry_completion_new_with_area (GtkCellArea *area)
* *
* Gets the entry @completion has been attached to. * 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 * 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 the model the #GtkEntryCompletion is using as data source.
* Returns %NULL if the model is unset. * 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 * is currently being used
* *
* Since: 2.4 * 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. * 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 * 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. * 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 * 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 * Returns whether the common prefix of the possible completions should
* be automatically inserted in the entry. * 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 * 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. * 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 * 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 * Returns whether the completion popup window will be resized to the
* width of the entry. * 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 * the entry
* *
* Since: 2.8 * 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 * Returns whether the completion popup window will appear even if there is
* only a single match. * 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 * number of matches
* *
* Since: 2.8 * Since: 2.8

4
gtk/gtkeventbox.c
View File

@ -205,7 +205,7 @@ gtk_event_box_get_property (GObject *object,
* Returns whether the event box has a visible window. * Returns whether the event box has a visible window.
* See gtk_event_box_set_visible_window() for details. * 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 * 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() * windows of its child. See gtk_event_box_set_above_child()
* for details. * 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 * window of its child
* *
* Since: 2.4 * Since: 2.4

20
gtk/gtkexpander.c
View File

@ -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. * 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 * Since: 2.4
*/ */
@ -1652,7 +1652,7 @@ gtk_expander_new (const gchar *label)
* accelerator called a mnemonic. * accelerator called a mnemonic.
* Pressing Alt and that key activates the button. * Pressing Alt and that key activates the button.
* *
* Return value: a new #GtkExpander widget. * Returns: a new #GtkExpander widget.
* *
* Since: 2.4 * Since: 2.4
*/ */
@ -1717,7 +1717,7 @@ gtk_expander_set_expanded (GtkExpander *expander,
* *
* See gtk_expander_set_expanded(). * See gtk_expander_set_expanded().
* *
* Return value: the current state of the expander * Returns: the current state of the expander
* *
* Since: 2.4 * Since: 2.4
*/ */
@ -1762,7 +1762,7 @@ gtk_expander_set_spacing (GtkExpander *expander,
* *
* Gets the value set by gtk_expander_set_spacing(). * 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 * Since: 2.4
*/ */
@ -1826,7 +1826,7 @@ gtk_expander_set_label (GtkExpander *expander,
* be avoided by fetching the label text directly from the label * be avoided by fetching the label text directly from the label
* widget. * 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. * by the widget and must not be modified or freed.
* *
* Since: 2.4 * Since: 2.4
@ -1886,7 +1886,7 @@ gtk_expander_set_use_underline (GtkExpander *expander,
* Returns whether an embedded underline in the expander label * Returns whether an embedded underline in the expander label
* indicates a mnemonic. See gtk_expander_set_use_underline(). * 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 * label indicates the mnemonic accelerator keys
* *
* Since: 2.4 * Since: 2.4
@ -1941,7 +1941,7 @@ gtk_expander_set_use_markup (GtkExpander *expander,
* the [Pango text markup language][PangoMarkupFormat]. * the [Pango text markup language][PangoMarkupFormat].
* See gtk_expander_set_use_markup(). * 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 * Since: 2.4
*/ */
@ -2016,7 +2016,7 @@ gtk_expander_set_label_widget (GtkExpander *expander,
* Retrieves the label widget for the frame. See * Retrieves the label widget for the frame. See
* gtk_expander_set_label_widget(). * gtk_expander_set_label_widget().
* *
* Return value: (transfer none): the label widget, * Returns: (transfer none): the label widget,
* or %NULL if there is none * or %NULL if there is none
* *
* Since: 2.4 * Since: 2.4
@ -2070,7 +2070,7 @@ gtk_expander_set_label_fill (GtkExpander *expander,
* Returns whether the label widget will fill all available * Returns whether the label widget will fill all available
* horizontal space allocated to @expander. * 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 * available horizontal space
* *
* Since: 2.22 * Since: 2.22
@ -2113,7 +2113,7 @@ gtk_expander_set_resize_toplevel (GtkExpander *expander,
* Returns whether the expander will resize the toplevel widget * Returns whether the expander will resize the toplevel widget
* containing the expander upon resizing and collpasing. * containing the expander upon resizing and collpasing.
* *
* Return value: the “resize toplevel” setting. * Returns: the “resize toplevel” setting.
* *
* Since: 3.2 * Since: 3.2
*/ */

84
gtk/gtkfilechooser.c
View File

@ -467,7 +467,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
* *
* Registers an error quark for #GtkFileChooser if necessary. * 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 * 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 * Gets the type of operation that the file chooser is performing; see
* gtk_file_chooser_set_action(). * 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 * 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 * Gets whether only local files can be selected in the
* file selector. See gtk_file_chooser_set_local_only() * 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 * 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 * Gets whether multiple files can be selected in the file
* selector. See gtk_file_chooser_set_select_multiple(). * 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 * 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. * Gets whether file choser will offer to create new folders.
* See gtk_file_chooser_set_create_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 * 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 * If the file chooser is in folder mode, this function returns the selected
* folder. * 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 * if no file is selected, or the selected file can't
* be represented with a local filename. Free with g_free(). * 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 * 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. * is already known, so the file chooser will use it.
* *
* Return value: Not useful. * Returns: Not useful.
* *
* Since: 2.4 * Since: 2.4
**/ **/
@ -759,7 +759,7 @@ gtk_file_chooser_set_filename (GtkFileChooser *chooser,
* folder of @chooser, then the current folder of @chooser will * folder of @chooser, then the current folder of @chooser will
* be changed to the folder containing @filename. * be changed to the folder containing @filename.
* *
* Return value: Not useful. * Returns: Not useful.
* *
* See also: gtk_file_chooser_set_filename() * 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 * folder cannot be represented as local filenames they will be ignored. (See
* gtk_file_chooser_get_uris()) * 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 * containing the filenames of all selected files and subfolders in
* the current folder. Free the returned list with g_slist_free(), * the current folder. Free the returned list with g_slist_free(),
* and the filenames with g_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] * [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
* for the rationale behind this. * for the rationale behind this.
* *
* Return value: Not useful. * Returns: Not useful.
* *
* Since: 2.4 * 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 * currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection. * 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 * or %NULL if the current path cannot be represented as a local
* filename. Free with g_free(). This function will also return * filename. Free with g_free(). This function will also return
* %NULL if the file chooser was unable to load the last folder that * %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 * If the file chooser is in folder mode, this function returns the selected
* folder. * 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 * 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. * (the default) a local URI will be returned for any FUSE locations.
* Free with g_free() * 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 * 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. * is already known, so the file chooser will use it.
* *
* Return value: Not useful. * Returns: Not useful.
* *
* Since: 2.4 * 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 * file in the current folder of @chooser, then the current folder of
* @chooser will be changed to the folder containing @filename. * @chooser will be changed to the folder containing @filename.
* *
* Return value: Not useful. * Returns: Not useful.
* *
* Since: 2.4 * 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 * Lists all the selected files and subfolders in the current folder of
* @chooser. The returned names are full absolute URIs. * @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 * files and subfolders in the current folder. Free the returned list
* with g_slist_free(), and the filenames with g_free(). * 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] * [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
* for the rationale behind this. * 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. * otherwise.
* *
* Since: 2.4 * 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 * currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
* usual way to get the selection. * 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 * 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 * 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. * 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. * Sets the current folder for @chooser from a #GFile.
* Internal function, see gtk_file_chooser_set_current_folder_uri(). * 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. * otherwise.
* *
* Since: 2.14 * Since: 2.14
@ -1332,7 +1332,7 @@ gtk_file_chooser_set_current_folder_file (GtkFileChooser *chooser,
* Gets the current folder of @chooser as #GFile. * Gets the current folder of @chooser as #GFile.
* See gtk_file_chooser_get_current_folder_uri(). * 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 * 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 * Selects the file referred to by @file. An internal function. See
* _gtk_file_chooser_select_uri(). * _gtk_file_chooser_select_uri().
* *
* Return value: Not useful. * Returns: Not useful.
* *
* Since: 2.14 * 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 * Lists all the selected files and subfolders in the current folder of @chooser
* as #GFile. An internal function, see gtk_file_chooser_get_uris(). * 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 * containing a #GFile for each selected file and subfolder in the
* current folder. Free the returned list with g_slist_free(), and * current folder. Free the returned list with g_slist_free(), and
* the files with g_object_unref(). * 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 * Since: 2.14
**/ **/
@ -1513,7 +1513,7 @@ gtk_file_chooser_get_file (GtkFileChooser *chooser)
* implementation detail, used for conversion between paths * implementation detail, used for conversion between paths
* and filenames and URIs. * and filenames and URIs.
* *
* Return value: the file system for @chooser. * Returns: the file system for @chooser.
* *
* Since: 2.4 * Since: 2.4
**/ **/
@ -1563,7 +1563,7 @@ gtk_file_chooser_set_preview_widget (GtkFileChooser *chooser,
* Gets the current preview widget; see * Gets the current preview widget; see
* gtk_file_chooser_set_preview_widget(). * 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 * Since: 2.4
**/ **/
@ -1617,7 +1617,7 @@ gtk_file_chooser_set_preview_widget_active (GtkFileChooser *chooser,
* should be shown for the current filename. See * should be shown for the current filename. See
* gtk_file_chooser_set_preview_widget_active(). * 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 * 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 * Gets whether a stock label should be drawn with the name of the previewed
* file. See gtk_file_chooser_set_use_preview_label(). * 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. * name of the previewed file, %FALSE otherwise.
**/ **/
gboolean 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 * Gets the #GFile that should be previewed in a custom preview
* Internal function, see gtk_file_chooser_get_preview_uri(). * 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(). * or %NULL if no file is selected. Free with g_object_unref().
* *
* Since: 2.14 * 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. * Adds a folder to be displayed with the shortcut folders in a file chooser.
* Internal function, see gtk_file_chooser_add_shortcut_folder(). * 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. * otherwise.
* *
* Since: 2.4 * 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 * Removes a folder from the shortcut folders in a file chooser. Internal
* function, see gtk_file_chooser_remove_shortcut_folder(). * 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. * otherwise.
* *
* Since: 2.4 * 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 * Gets the filename that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget(). * 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 * no file is selected, or if the selected file cannot be represented
* as a local filename. Free with g_free() * 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 * Gets the URI that should be previewed in a custom preview
* widget. See gtk_file_chooser_set_preview_widget(). * 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(). * selected. Free with g_free().
* *
* Since: 2.4 * Since: 2.4
@ -1834,7 +1834,7 @@ gtk_file_chooser_set_extra_widget (GtkFileChooser *chooser,
* Gets the current preview widget; see * Gets the current preview widget; see
* gtk_file_chooser_set_extra_widget(). * 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 * Since: 2.4
**/ **/
@ -1905,7 +1905,7 @@ gtk_file_chooser_remove_filter (GtkFileChooser *chooser,
* Lists the current set of user-selectable filters; see * Lists the current set of user-selectable filters; see
* gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter(). * 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 * #GSList containing the current set of user selectable filters. The
* contents of the list are owned by GTK+, but you must free the list * 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. * 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(). * 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 * Since: 2.4
**/ **/
@ -1983,7 +1983,7 @@ gtk_file_chooser_get_filter (GtkFileChooser *chooser)
* application. For example, you can use this to add a * application. For example, you can use this to add a
* “/usr/share/mydrawprogram/Clipart” folder to the volume list. * “/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. * otherwise. In the latter case, the @error will be set as appropriate.
* *
* Since: 2.4 * 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. * 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. * In the latter case, the @error will be set as appropriate.
* *
* See also: gtk_file_chooser_add_shortcut_folder() * 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 * Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder(). * 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 * folder filenames, or %NULL if there are no shortcut folders. Free
* the returned list with g_slist_free(), and the filenames with * the returned list with g_slist_free(), and the filenames with
* g_free(). * 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 * by the application. For example, you can use this to add a
* “file:///usr/share/mydrawprogram/Clipart” folder to the volume list. * “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. * otherwise. In the latter case, the @error will be set as appropriate.
* *
* Since: 2.4 * 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. * 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. * In the latter case, the @error will be set as appropriate.
* *
* See also: gtk_file_chooser_add_shortcut_folder_uri() * 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 * Queries the list of shortcut folders in the file chooser, as set by
* gtk_file_chooser_add_shortcut_folder_uri(). * 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 * URIs, or %NULL if there are no shortcut folders. Free the returned
* list with g_slist_free(), and the URIs with g_free(). * 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. * Gets whether hidden files and folders are displayed in the file selector.
* See gtk_file_chooser_set_show_hidden(). * 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 * 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 * Queries whether a file chooser is set to confirm for overwriting when the user
* types a file name that already exists. * 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. * %FALSE otherwise.
* *
* Since: 2.8 * Since: 2.8

2
gtk/gtkfilechooserbutton.c
View File

@ -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. * Returns whether the button grabs focus when it is clicked with the mouse.
* See gtk_file_chooser_button_set_focus_on_click(). * 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. * the mouse.
* *
* Since: 2.10 * Since: 2.10

2
gtk/gtkfilechooserdialog.c
View File

@ -556,7 +556,7 @@ gtk_file_chooser_dialog_new_valist (const gchar *title,
* Creates a new #GtkFileChooserDialog. This function is analogous to * Creates a new #GtkFileChooserDialog. This function is analogous to
* gtk_dialog_new_with_buttons(). * gtk_dialog_new_with_buttons().
* *
* Return value: a new #GtkFileChooserDialog * Returns: a new #GtkFileChooserDialog
* *
* Since: 2.4 * Since: 2.4
**/ **/

6
gtk/gtkfilechooserentry.c
View File

@ -710,7 +710,7 @@ delete_text_callback (GtkFileChooserEntry *chooser_entry,
* which is an entry with completion with respect to a * which is an entry with completion with respect to a
* #GtkFileSystem object. * #GtkFileSystem object.
* *
* Return value: the newly created #GtkFileChooserEntry * Returns: the newly created #GtkFileChooserEntry
**/ **/
GtkWidget * GtkWidget *
_gtk_file_chooser_entry_new (gboolean eat_tabs) _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 * be different. If the user has entered unparsable text, or text which
* the entry cannot handle, this will return %NULL. * 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. * the value after use.
**/ **/
GFile * 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() * and if a filename path is needed, g_file_get_child_for_display_name()
* must be used * 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. * chooser entry and must not be modified or freed.
**/ **/
const gchar * const gchar *

2
gtk/gtkfilechooserwidget.c
View File

@ -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 * be embedded in custom windows, and it is the same widget that is used by
* #GtkFileChooserDialog. * #GtkFileChooserDialog.
* *
* Return value: a new #GtkFileChooserWidget * Returns: a new #GtkFileChooserWidget
* *
* Since: 2.4 * Since: 2.4
**/ **/

8
gtk/gtkfilefilter.c
View File

@ -352,7 +352,7 @@ gtk_file_filter_buildable_custom_tag_end (GtkBuildable *buildable,
* gtk_file_filter_add_pattern (filter, "*"); * gtk_file_filter_add_pattern (filter, "*");
* ]| * ]|
* *
* Return value: a new #GtkFileFilter * Returns: a new #GtkFileFilter
* *
* Since: 2.4 * 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(). * 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 * or %NULL. This value is owned by GTK+ and must not
* be modified or freed. * be modified or freed.
* *
@ -540,7 +540,7 @@ gtk_file_filter_add_custom (GtkFileFilter *filter,
* is intended principally for use in the implementation of * is intended principally for use in the implementation of
* #GtkFileChooser. * #GtkFileChooser.
* *
* Return value: bitfield of flags indicating needed fields when * Returns: bitfield of flags indicating needed fields when
* calling gtk_file_filter_filter() * calling gtk_file_filter_filter()
* *
* Since: 2.4 * Since: 2.4
@ -565,7 +565,7 @@ gtk_file_filter_get_needed (GtkFileFilter *filter)
* is intended principally for use in the implementation of * is intended principally for use in the implementation of
* #GtkFileChooser. * #GtkFileChooser.
* *
* Return value: %TRUE if the file should be displayed * Returns: %TRUE if the file should be displayed
* *
* Since: 2.4 * Since: 2.4
**/ **/

8
gtk/gtkfilesystemmodel.c
View File

@ -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() * to the list using _gtk_file_system_model_add_and_query_file()
* or _gtk_file_system_model_update_file(). * or _gtk_file_system_model_update_file().
* *
* Return value: the newly created #GtkFileSystemModel * Returns: the newly created #GtkFileSystemModel
**/ **/
GtkFileSystemModel * GtkFileSystemModel *
_gtk_file_system_model_new (GtkFileSystemModelGetValue get_func, _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 * it will also monitor the drectory and update the model's
* contents to reflect changes, if the @directory supports monitoring. * contents to reflect changes, if the @directory supports monitoring.
* *
* Return value: the newly created #GtkFileSystemModel * Returns: the newly created #GtkFileSystemModel
**/ **/
GtkFileSystemModel * GtkFileSystemModel *
_gtk_file_system_model_new_for_directory (GFile * dir, _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 * Gets the #GFileInfo-struct for a particular row
* of @model. * 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. * is owned by @model and must not be modified or freed.
* If you want to keep the information for later use, * If you want to keep the information for later use,
* you must take a reference, since the #GFileInfo-struct may be * 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. * 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, * or freed. If you want to save the path for later use,
* you must take a ref, since the object may be freed * you must take a ref, since the object may be freed
* on later changes to the file system. * on later changes to the file system.

2
gtk/gtkflowbox.c
View File

@ -4145,7 +4145,7 @@ gtk_flow_box_set_vadjustment (GtkFlowBox *box,
* Returns whether the box is homogeneous (all children are the * Returns whether the box is homogeneous (all children are the
* same size). See gtk_box_set_homogeneous(). * 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 * Since: 3.12
*/ */

4
gtk/gtkfontbutton.c
View File

@ -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. * 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 * 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. * 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 * Since: 2.4
**/ **/

14
gtk/gtkfontchooser.c
View File

@ -136,7 +136,7 @@ gtk_font_chooser_default_init (GtkFontChooserInterface *iface)
* *
* If the selected font is not installed, returns %NULL. * 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 * selected font family, or %NULL. The returned object is owned by @fontchooser
* and must not be modified or freed. * 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. * 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 * selected font group details, or %NULL. The returned object is owned by
* @fontchooser and must not be modified or freed. * @fontchooser and must not be modified or freed.
* *
@ -179,7 +179,7 @@ gtk_font_chooser_get_font_face (GtkFontChooser *fontchooser)
* *
* The selected font size. * 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. * or -1 if no font size is selected.
* *
* Since: 3.2 * 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 * Use pango_font_description_equal() if you want to compare two
* font descriptions. * 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 * of the current font, or %NULL if no font is selected. You must
* free this string with g_free(). * 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 * Use pango_font_description_equal() if you want to compare two
* font descriptions. * 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. * current font, or %NULL if no font is selected.
* *
* Since: 3.2 * Since: 3.2
@ -302,7 +302,7 @@ gtk_font_chooser_set_font_desc (GtkFontChooser *fontchooser,
* *
* Gets the text displayed in the preview area. * 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 * preview area
* *
* Since: 3.2 * Since: 3.2
@ -345,7 +345,7 @@ gtk_font_chooser_set_preview_text (GtkFontChooser *fontchooser,
* *
* Returns whether the preview entry is shown or not. * 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. * or %FALSE if it is hidden.
* *
* Since: 3.2 * Since: 3.2

2
gtk/gtkfontchooserdialog.c
View File

@ -177,7 +177,7 @@ G_GNUC_END_IGNORE_DEPRECATIONS
* *
* Creates a new #GtkFontChooserDialog. * Creates a new #GtkFontChooserDialog.
* *
* Return value: a new #GtkFontChooserDialog * Returns: a new #GtkFontChooserDialog
* *
* Since: 3.2 * Since: 3.2
*/ */

2
gtk/gtkfontchooserwidget.c
View File

@ -563,7 +563,7 @@ gtk_font_chooser_widget_init (GtkFontChooserWidget *fontchooser)
* *
* Creates a new #GtkFontChooserWidget. * Creates a new #GtkFontChooserWidget.
* *
* Return value: a new #GtkFontChooserWidget * Returns: a new #GtkFontChooserWidget
* *
* Since: 3.2 * Since: 3.2
*/ */

Some files were not shown because too many files have changed in this diff Show More