AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-11-09 18:30:08 +00:00
Code Issues Projects Releases Wiki Activity

docs: Reduce redundancy

Browse Source 
Remove a boatload of "or %NULL" from nullable parameters
and return values. gi-docgen generates suitable text from
the annotation that we don't need to duplicate.

This adds a few missing nullable annotations too.
This commit is contained in:
Matthias Clasen 2021-05-20 20:45:06 -04:00
parent 7fe0610b68
commit 4a0d3d7acc
146 changed files with 502 additions and 570 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
gdk/gdkapplaunchcontext.c
View File

@ -237,7 +237,7 @@ gdk_app_launch_context_set_timestamp (GdkAppLaunchContext *context,
/**
* gdk_app_launch_context_set_icon:
* @context: a `GdkAppLaunchContext`
* @icon: (nullable): a #GIcon, or %NULL
* @icon: (nullable): a #GIcon
*
* Sets the icon for applications that are launched with this
* context.
@ -267,7 +267,7 @@ gdk_app_launch_context_set_icon (GdkAppLaunchContext *context,
/**
* gdk_app_launch_context_set_icon_name:
* @context: a `GdkAppLaunchContext`
* @icon_name: (nullable): an icon name, or %NULL
* @icon_name: (nullable): an icon name
*
* Sets the icon for applications that are launched with this context.
*

14
gdk/gdkclipboard.c
View File

@ -574,7 +574,7 @@ gdk_clipboard_store_async (GdkClipboard *clipboard,
* gdk_clipboard_store_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
* @error: a `GError` location to store the error occurring, or %NULL to ignore.
* @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard store.
*
@ -684,7 +684,7 @@ gdk_clipboard_read_async (GdkClipboard *clipboard,
*
* See [method@Gdk.Clipboard.read_async].
*
* Returns: (transfer full) (nullable): a `GInputStream` or %NULL on error
* Returns: (transfer full) (nullable): a `GInputStream`
*/
GInputStream *
gdk_clipboard_read_finish (GdkClipboard *clipboard,
@ -872,7 +872,7 @@ gdk_clipboard_read_value_async (GdkClipboard *clipboard,
* gdk_clipboard_read_value_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
* @error: a GError` location to store the error occurring, or %NULL to ignore
* @error: a GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
@ -931,13 +931,13 @@ gdk_clipboard_read_texture_async (GdkClipboard *clipboard,
* gdk_clipboard_read_texture_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
* @error: a `GError` location to store the error occurring, or %NULL to ignore
* @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
* See [method@Gdk.Clipboard.read_texture_async].
*
* Returns: (transfer full) (nullable): a new `GdkTexture` or %NULL on error
* Returns: (transfer full) (nullable): a new `GdkTexture`
*/
GdkTexture *
gdk_clipboard_read_texture_finish (GdkClipboard *clipboard,
@ -996,13 +996,13 @@ gdk_clipboard_read_text_async (GdkClipboard *clipboard,
* gdk_clipboard_read_text_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
* @error: a `GError` location to store the error occurring, or %NULL to ignore
* @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
* See [method@Gdk.Clipboard.read_text_async].
*
* Returns: (transfer full) (nullable): a new string or %NULL on error
* Returns: (transfer full) (nullable): a new string
*/
char *
gdk_clipboard_read_text_finish (GdkClipboard *clipboard,

2
gdk/gdkcontentformats.c
View File

@ -384,7 +384,7 @@ gdk_content_formats_match_gtype (const GdkContentFormats *first,
*
* If no matching mime type is found, %NULL is returned.
*
* Returns: (nullable): The first common mime type or %NULL if none.
* Returns: (nullable): The first common mime type or %NULL if none
*/
const char *
gdk_content_formats_match_mime_type (const GdkContentFormats *first,

4
gdk/gdkcontentprovider.c
View File

@ -319,7 +319,7 @@ gdk_content_provider_write_mime_type_async (GdkContentProvider *provider,
* gdk_content_provider_write_mime_type_finish:
* @provider: a `GdkContentProvider`
* @result: a `GAsyncResult`
* @error: a `GError` location to store the error occurring, or %NULL to ignore
* @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous write operation.
*
@ -343,7 +343,7 @@ gdk_content_provider_write_mime_type_finish (GdkContentProvider *provider,
* gdk_content_provider_get_value:
* @provider: a `GdkContentProvider`
* @value: the `GValue` to fill
* @error: a `GError` location to store the error occurring, or %NULL to ignore
* @error: a `GError` location to store the error occurring
*
* Gets the contents of @provider stored in @value.
*

2
gdk/gdkcursor.c
View File

@ -379,7 +379,7 @@ gdk_cursor_new_from_texture (GdkTexture *texture,
* it is used on does not support textured cursors.
*
* Returns: (transfer none) (nullable): the fallback of the cursor or %NULL
* to use the default cursor as fallback.
* to use the default cursor as fallback
*/
GdkCursor *
gdk_cursor_get_fallback (GdkCursor *cursor)

6
gdk/gdkdevice.c
View File

@ -1145,7 +1145,7 @@ _gdk_device_surface_at_position (GdkDevice *device,
* }
* ```
*
* Returns: (nullable): the vendor ID, or %NULL
* Returns: (nullable): the vendor ID
*/
const char *
gdk_device_get_vendor_id (GdkDevice *device)
@ -1164,7 +1164,7 @@ gdk_device_get_vendor_id (GdkDevice *device)
* This ID is retrieved from the device, and does not change.
* See [method@Gdk.Device.get_vendor_id] for more information.
*
* Returns: (nullable): the product ID, or %NULL
* Returns: (nullable): the product ID
*/
const char *
gdk_device_get_product_id (GdkDevice *device)
@ -1239,7 +1239,7 @@ gdk_device_get_num_touches (GdkDevice *device)
*
* Retrieves the current tool for @device.
*
* Returns: (transfer none): the `GdkDeviceTool`, or %NULL
* Returns: (transfer none): the `GdkDeviceTool`
*/
GdkDeviceTool *
gdk_device_get_device_tool (GdkDevice *device)

2
gdk/gdkdrag.c
View File

@ -692,7 +692,7 @@ gdk_drag_set_selected_action (GdkDrag *drag,
* drag operation. The surface is owned by @drag and will be destroyed
* when the drag operation is over.
*
* Returns: (nullable) (transfer none): the drag surface, or %NULL
* Returns: (nullable) (transfer none): the drag surface
*/
GdkSurface *
gdk_drag_get_drag_surface (GdkDrag *drag)

4
gdk/gdkdrawcontext.c
View File

@ -219,7 +219,7 @@ gdk_draw_context_surface_resized (GdkDrawContext *context)
*
* Retrieves the `GdkDisplay` the @context is created for
*
* Returns: (nullable) (transfer none): a `GdkDisplay` or %NULL
* Returns: (nullable) (transfer none): the `GdkDisplay`
*/
GdkDisplay *
gdk_draw_context_get_display (GdkDrawContext *context)
@ -237,7 +237,7 @@ gdk_draw_context_get_display (GdkDrawContext *context)
*
* Retrieves the surface that @context is bound to.
*
* Returns: (nullable) (transfer none): a #GdkSurface or %NULL
* Returns: (nullable) (transfer none): the #GdkSurface
*/
GdkSurface *
gdk_draw_context_get_surface (GdkDrawContext *context)

6
gdk/gdkdrop.c
View File

@ -694,7 +694,7 @@ gdk_drop_read_async (GdkDrop *self,
* @self: a `GdkDrop`
* @result: a `GAsyncResult`
* @out_mime_type: (out) (type utf8): return location for the used mime type
* @error: (nullable): location to store error information on failure, or %NULL
* @error: (nullable): location to store error information on failure
*
* Finishes an async drop read operation.
*
@ -705,7 +705,7 @@ gdk_drop_read_async (GdkDrop *self,
*
* See [method@Gdk.Drop.read_async].
*
* Returns: (nullable) (transfer full): the `GInputStream`, or %NULL
* Returns: (nullable) (transfer full): the `GInputStream`
*/
GInputStream *
gdk_drop_read_finish (GdkDrop *self,
@ -891,7 +891,7 @@ gdk_drop_read_value_async (GdkDrop *self,
* gdk_drop_read_value_finish:
* @self: a `GdkDrop`
* @result: a `GAsyncResult`
* @error: a `GError` location to store the error occurring, or %NULL to ignore
* @error: a `GError` location to store the error occurring
*
* Finishes an async drop read.
*

9
gdk/gdkevents.c
View File

@ -574,9 +574,8 @@ _gdk_event_queue_remove_link (GdkDisplay *display,
* Removes and returns the first event from the event
* queue that is not still being filled in.
*
* Returns: (nullable): the event, or %NULL. Ownership is transferred
* to the caller.
**/
* Returns: (nullable) (transfer full): the event
*/
GdkEvent*
_gdk_event_unqueue (GdkDisplay *display)
{
@ -1238,8 +1237,8 @@ gdk_event_get_device (GdkEvent *event)
* the application lifetime, if settings must be stored
* persistently across runs, see [method@Gdk.DeviceTool.get_serial].
*
* Returns: (transfer none) (nullable): The current device tool, or %NULL
**/
* Returns: (transfer none) (nullable): The current device tool
*/
GdkDeviceTool *
gdk_event_get_device_tool (GdkEvent *event)
{

8
gdk/gdkglcontext.c
View File

@ -1127,7 +1127,7 @@ gdk_gl_context_make_current (GdkGLContext *context)
*
* Retrieves the display the @context is created for
*
* Returns: (nullable) (transfer none): a `GdkDisplay` or %NULL
* Returns: (nullable) (transfer none): a `GdkDisplay`
*/
GdkDisplay *
gdk_gl_context_get_display (GdkGLContext *context)
@ -1143,7 +1143,7 @@ gdk_gl_context_get_display (GdkGLContext *context)
*
* Retrieves the surface used by the @context.
*
* Returns: (nullable) (transfer none): a `GdkSurface` or %NULL
* Returns: (nullable) (transfer none): a `GdkSurface`
*/
GdkSurface *
gdk_gl_context_get_surface (GdkGLContext *context)
@ -1159,7 +1159,7 @@ gdk_gl_context_get_surface (GdkGLContext *context)
*
* Retrieves the `GdkGLContext` that this @context share data with.
*
* Returns: (nullable) (transfer none): a `GdkGLContext` or %NULL
* Returns: (nullable) (transfer none): a `GdkGLContext`
*/
GdkGLContext *
gdk_gl_context_get_shared_context (GdkGLContext *context)
@ -1223,7 +1223,7 @@ gdk_gl_context_clear_current (void)
*
* Retrieves the current `GdkGLContext`.
*
* Returns: (nullable) (transfer none): the current `GdkGLContext`, or %NULL
* Returns: (nullable) (transfer none): the current `GdkGLContext`
*/
GdkGLContext *
gdk_gl_context_get_current (void)

5
gdk/gdkmonitor.c
View File

@ -421,8 +421,7 @@ gdk_monitor_get_connector (GdkMonitor *monitor)
* The PNP ID registry is located at
* [https://uefi.org/pnp_id_list](https://uefi.org/pnp_id_list).
*
* Returns: (transfer none) (nullable): the name of the manufacturer,
* or %NULL
* Returns: (transfer none) (nullable): the name of the manufacturer
*/
const char *
gdk_monitor_get_manufacturer (GdkMonitor *monitor)
@ -438,7 +437,7 @@ gdk_monitor_get_manufacturer (GdkMonitor *monitor)
*
* Gets the string identifying the monitor model, if available.
*
* Returns: (transfer none) (nullable): the monitor model, or %NULL
* Returns: (transfer none) (nullable): the monitor model
*/
const char *
gdk_monitor_get_model (GdkMonitor *monitor)

3
gdk/gdkpixbuf-drawable.c
View File

@ -225,8 +225,7 @@ gdk_pixbuf_get_from_surface (cairo_surface_t *surface,
* stages will almost certainly convert the pixbuf back into a texture
* to draw it on screen.
*
* Returns: (transfer full) (nullable): a new #GdkPixbuf or %NULL
* in case of an error
* Returns: (transfer full) (nullable): a new #GdkPixbuf
*/
GdkPixbuf *
gdk_pixbuf_get_from_texture (GdkTexture *texture)

2
gdk/gdkrectangle.c
View File

@ -92,7 +92,7 @@ gdk_rectangle_union (const GdkRectangle *src1,
* @src1: a `GdkRectangle`
* @src2: a `GdkRectangle`
* @dest: (out caller-allocates) (optional): return location for the
* intersection of @src1 and @src2, or %NULL
* intersection of @src1 and @src2
*
* Calculates the intersection of two rectangles.
*

29
gdk/gdksurface.c
View File

@ -1164,8 +1164,7 @@ gdk_surface_get_paint_gl_context (GdkSurface *surface,
* Before using the returned `GdkGLContext`, you will need to
* call [method@Gdk.GLContext.make_current] or [method@Gdk.GLContext.realize].
*
* Returns: (transfer full): the newly created `GdkGLContext`,
* or %NULL on error
* Returns: (transfer full) (nullable): the newly created `GdkGLContext`
*/
GdkGLContext *
gdk_surface_create_gl_context (GdkSurface *surface,
@ -1696,9 +1695,9 @@ gdk_surface_constrain_size (GdkGeometry *geometry,
* gdk_surface_get_device_position:
* @surface: a `GdkSurface`
* @device: pointer `GdkDevice` to query to
* @x: (out) (optional): return locatio for the X coordinate of @device, or %NULL
* @y: (out) (optional): return location for the Y coordinate of @device, or %NULL
* @mask: (out) (optional): return location for the modifier mask, or %NULL
* @x: (out) (optional): return locatio for the X coordinate of @device
* @y: (out) (optional): return location for the Y coordinate of @device
* @mask: (out) (optional): return location for the modifier mask
*
* Obtains the current device position and modifier state.
*
@ -1839,10 +1838,9 @@ gdk_surface_set_cursor_internal (GdkSurface *surface,
* If the return value is %NULL then there is no custom cursor set on
* the surface, and it is using the cursor for its parent surface.
*
* Returns: (nullable) (transfer none): a `GdkCursor`, or %NULL. The
* returned object is owned by the `GdkSurface` and should not be
* unreferenced directly. Use [method@Gdk.Surface.set_cursor] to
* unset the cursor of the surface
* Use [method@Gdk.Surface.set_cursor] to unset the cursor of the surface.
*
* Returns: (nullable) (transfer none): a `GdkCursor`
*/
GdkCursor *
gdk_surface_get_cursor (GdkSurface *surface)
@ -1920,10 +1918,9 @@ gdk_surface_set_cursor (GdkSurface *surface,
* If the return value is %NULL then there is no custom cursor set on the
* specified surface, and it is using the cursor for its parent surface.
*
* Returns: (nullable) (transfer none): a `GdkCursor`, or %NULL. The
* returned object is owned by the `GdkSurface` and should not be
* unreferenced directly. Use [method@Gdk.Surface.set_cursor] to unset
* the cursor of the surface
* Use [method@Gdk.Surface.set_cursor] to unset the cursor of the surface.
*
* Returns: (nullable) (transfer none): a `GdkCursor`
*/
GdkCursor *
gdk_surface_get_device_cursor (GdkSurface *surface,
@ -2415,8 +2412,7 @@ gdk_surface_destroy_notify (GdkSurface *surface)
* the source if [method@Gdk.Drag.get_selected_action] returns
* %GDK_ACTION_MOVE.
*
* Returns: (transfer full) (nullable): a newly created [class@Gdk.Drag]
* or %NULL on error
* Returns: (transfer full) (nullable): a newly created `GdkDrag`
*/
GdkDrag *
gdk_drag_begin (GdkSurface *surface,
@ -2624,7 +2620,8 @@ gdk_surface_get_scale_factor (GdkSurface *surface)
/**
* gdk_surface_set_opaque_region:
* @surface: a top-level `GdkSurface`
* @region: (nullable): a region, or %NULL
* @region: (nullable): a region, or %NULL to make the entire
* surface opaque
*
* Marks a region of the `GdkSurface` as opaque.
*

2
gdk/gdktexture.c
View File

@ -353,7 +353,7 @@ gdk_texture_new_from_resource (const char *resource_path)
*
* If %NULL is returned, then @error will be set.
*
* Return value: A newly-created `GdkTexture` or %NULL if an error occurred.
* Return value: A newly-created `GdkTexture`
*/
GdkTexture *
gdk_texture_new_from_file (GFile *file,

2
gdk/wayland/gdkdisplay-wayland.c
View File

@ -818,7 +818,7 @@ gdk_wayland_display_get_next_serial (GdkDisplay *display)
* Gets the startup notification ID for a Wayland display, or %NULL
* if no ID has been defined.
*
* Returns: (nullable): the startup notification ID for @display, or %NULL
* Returns: (nullable): the startup notification ID for @display
*/
const char *
gdk_wayland_display_get_startup_notification_id (GdkDisplay *display)

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

@ -2001,9 +2001,9 @@ gdk_x11_lookup_xdisplay (Display *xdisplay)
* Given the root window ID of one of the screen’s of a #GdkDisplay,
* finds the screen.
*
* Returns: (transfer none): the #GdkX11Screen corresponding to
* @xrootwin, or %NULL.
**/
* Returns: (transfer none) (nullable): the #GdkX11Screen
* corresponding to @xrootwin
*/
GdkX11Screen *
_gdk_x11_display_screen_for_xrootwin (GdkDisplay *display,
Window xrootwin)

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

@ -290,8 +290,7 @@ _gdk_x11_screen_init_visuals (GdkX11Screen *x11_screen,
*
* Looks up the #GdkVisual for a particular screen and X Visual ID.
*
* Returns: (transfer none) (type GdkX11Visual): the #GdkVisual (owned by the screen
* object), or %NULL if the visual ID wasn’t found.
* Returns: (transfer none) (nullable) (type GdkX11Visual): the #GdkVisual
*/
GdkX11Visual *
gdk_x11_screen_lookup_visual (GdkX11Screen *x11_screen,

3
gsk/gskglshader.c
View File

@ -578,8 +578,7 @@ gsk_gl_shader_get_source (GskGLShader *shader)
* Gets the resource path for the GLSL sourcecode being used
* to render this shader.
*
* Returns: (transfer none): The resource path for the shader,
* or %NULL if none.
* Returns: (transfer none) (nullable): The resource path for the shader
*/
const char *
gsk_gl_shader_get_resource (GskGLShader *shader)

2
gsk/gskrendernode.c
View File

@ -600,7 +600,7 @@ gsk_render_node_write_to_file (GskRenderNode *node,
/**
* gsk_render_node_deserialize:
* @bytes: the bytes containing the data
* @error_func: (nullable) (scope call): Callback on parsing errors or %NULL
* @error_func: (nullable) (scope call): Callback on parsing errors
* @user_data: (closure error_func): user_data for @error_func
*
* Loads data previously created via gsk_render_node_serialize().

4
gsk/gsktransform.c
View File

@ -94,7 +94,7 @@ gsk_transform_has_class (GskTransform *self,
* @transform_class: class structure for this self
* @category: The category of this transform. Will be used to initialize
* the result's category together with &next's category
* @next: (transfer full): Next transform to multiply with or %NULL if none
* @next: (transfer full) (nullable): Next transform to multiply with
*
* Returns: (transfer full): the newly created #GskTransform
*/
@ -217,7 +217,7 @@ static const GskTransformClass GSK_IDENTITY_TRANSFORM_CLASS =
/*<private>
* gsk_transform_is_identity:
* @transform: (nullable): A transform or %NULL
* @transform: (nullable): A transform
*
* Checks if the transform is a representation of the identity
* transform.

5
gsk/ngl/gskngldriver.c
View File

@ -1016,14 +1016,13 @@ gsk_ngl_driver_release_render_target (GskNglDriver *self,
* gsk_ngl_driver_lookup_shader:
* @self: a #GskNglDriver
* @shader: the shader to lookup or load
* @error: a location for a #GError, or %NULL
* @error: a location for a #GError
*
* Attepts to load @shader from the shader cache.
*
* If it has not been loaded, then it will compile the shader on demand.
*
* Returns: (transfer none): a #GskGLShader if successful; otherwise
* %NULL and @error is set.
* Returns: (nullable) (transfer none): a #GskGLShader
*/
GskNglProgram *
gsk_ngl_driver_lookup_shader (GskNglDriver *self,

4
gtk/css/gtkcssdataurl.c
View File

@ -38,11 +38,11 @@
* @url: the URL to parse
* @out_mimetype: (out nullable optional): Return location to set the contained
* mime type to. If no mime type was specified, this value is set to %NULL.
* @error: error location or %NULL for none
* @error: error location
*
* Decodes a data URL according to RFC2397 and returns the decoded data.
*
* Returns: a new #GBytes with the decoded data or %NULL on error
* Returns: a new #GBytes with the decoded data
**/
GBytes *
gtk_css_data_url_parse (const char *url,

5
gtk/css/gtkcssparser.c
View File

@ -158,8 +158,7 @@ gtk_css_parser_unref (GtkCssParser *self)
* for example when raw data is parsed - %NULL is returned.
*
* Returns: (nullable) (transfer none): The file being parsed
* or %NULL.
**/
*/
GFile *
gtk_css_parser_get_file (GtkCssParser *self)
{
@ -971,7 +970,7 @@ gtk_css_parser_parse_url_arg (GtkCssParser *parser,
* consumes it, resolves the URL and returns the resulting #GFile.
* On failure, an error is emitted and %NULL is returned.
*
* Returns: (nullable) (transfer full): the resulting URL or %NULL on error
* Returns: (nullable) (transfer full): the resulting URL
**/
char *
gtk_css_parser_consume_url (GtkCssParser *self)

4
gtk/gtkappchooserdialog.c
View File

@ -666,7 +666,7 @@ set_parent_and_flags (GtkWidget *dialog,
/**
* gtk_app_chooser_dialog_new:
* @parent: (nullable): a `GtkWindow`, or %NULL
* @parent: (nullable): a `GtkWindow`
* @flags: flags for this dialog
* @file: a `GFile`
*
@ -696,7 +696,7 @@ gtk_app_chooser_dialog_new (GtkWindow *parent,
/**
* gtk_app_chooser_dialog_new_for_content_type:
* @parent: (nullable): a `GtkWindow`, or %NULL
* @parent: (nullable): a `GtkWindow`
* @flags: flags for this dialog
* @content_type: a content type string
*

2
gtk/gtkapplicationwindow.c
View File

@ -843,7 +843,7 @@ gtk_application_window_set_help_overlay (GtkApplicationWindow *window,
* See [method@Gtk.ApplicationWindow.set_help_overlay].
*
* Returns: (transfer none) (nullable): the help overlay associated
* with @window, or %NULL
* with @window
*/
GtkShortcutsWindow *
gtk_application_window_get_help_overlay (GtkApplicationWindow *window)

2
gtk/gtkassistant.c
View File

@ -1776,7 +1776,7 @@ gtk_assistant_remove_page (GtkAssistant *assistant,
/**
* gtk_assistant_set_forward_page_func:
* @assistant: a `GtkAssistant`
* @page_func: (nullable): the `GtkAssistant`PageFunc, or %NULL
* @page_func: (nullable): the `GtkAssistantPageFunc`, or %NULL
* to use the default one
* @data: user data for @page_func
* @destroy: destroy notifier for @data

2
gtk/gtkbox.c
View File

@ -530,7 +530,7 @@ gtk_box_insert_child_after (GtkBox *box,
* gtk_box_reorder_child_after:
* @box: a `GtkBox`
* @child: the `GtkWidget` to move, must be a child of @box
* @sibling: (nullable): the sibling to move @child after, or %NULL
* @sibling: (nullable): the sibling to move @child after
*
* Moves @child to the position after @sibling in the list
* of @box children.

2
gtk/gtkbuildable.c
View File

@ -106,7 +106,7 @@ gtk_buildable_get_buildable_id (GtkBuildable *buildable)
* @buildable: a `GtkBuildable`
* @builder: a `GtkBuilder`
* @child: child to add
* @type: (nullable): kind of child or %NULL
* @type: (nullable): kind of child
*
* Adds a child to @buildable. @type is an optional string
* describing how the child should be added.

25
gtk/gtkbuilder.c
View File

@ -1176,7 +1176,7 @@ gtk_builder_new (void)
* gtk_builder_add_from_file:
* @builder: a `GtkBuilder`
* @filename: the name of the file to parse
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Parses a file containing a UI definition and merges it with
* the current contents of @builder.
@ -1247,7 +1247,7 @@ gtk_builder_add_from_file (GtkBuilder *builder,
* @builder: a `GtkBuilder`
* @filename: the name of the file to parse
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Parses a file containing a UI definition building only the
* requested objects and merges them with the current contents
@ -1315,7 +1315,7 @@ gtk_builder_add_objects_from_file (GtkBuilder *builder,
* @template_type: the type that the template is for
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Main private entry point for building composite components
* from template XML.
@ -1372,7 +1372,7 @@ gtk_builder_extend_with_template (GtkBuilder *builder,
* gtk_builder_add_from_resource:
* @builder: a `GtkBuilder`
* @resource_path: the path of the resource file to parse
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an erro
*
* Parses a resource file containing a UI definition
* and merges it with the current contents of @builder.
@ -1450,7 +1450,7 @@ gtk_builder_add_from_resource (GtkBuilder *builder,
* @builder: a `GtkBuilder`
* @resource_path: the path of the resource file to parse
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Parses a resource file containing a UI definition, building
* only the requested objects and merges them with the current
@ -1525,7 +1525,7 @@ gtk_builder_add_objects_from_resource (GtkBuilder *builder,
* @builder: a `GtkBuilder`
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Parses a string containing a UI definition and merges it
* with the current contents of @builder.
@ -1584,7 +1584,7 @@ gtk_builder_add_from_string (GtkBuilder *builder,
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Parses a string containing a UI definition, building only the
* requested objects and merges them with the current contents of
@ -1646,7 +1646,6 @@ gtk_builder_add_objects_from_string (GtkBuilder *builder,
* of the returned object.
*
* Returns: (nullable) (transfer none): the object named @name
* or %NULL if it could not be found in the object tree.
*/
GObject *
gtk_builder_get_object (GtkBuilder *builder,
@ -1694,7 +1693,7 @@ gtk_builder_get_objects (GtkBuilder *builder)
/**
* gtk_builder_set_translation_domain: (attributes org.gtk.Method.set_property=translation-domain)
* @builder: a `GtkBuilder`
* @domain: (nullable): the translation domain or %NULL
* @domain: (nullable): the translation domain
*
* Sets the translation domain of @builder.
*/
@ -1721,8 +1720,6 @@ gtk_builder_set_translation_domain (GtkBuilder *builder,
* Gets the translation domain of @builder.
*
* Returns: (transfer none) (nullable): the translation domain
* or %NULL. This string is owned by the builder object and
* must not be modified or freed.
*/
const char *
gtk_builder_get_translation_domain (GtkBuilder *builder)
@ -1938,7 +1935,7 @@ _gtk_builder_finish (GtkBuilder *builder,
* @pspec: the `GParamSpec` for the property
* @string: the string representation of the value
* @value: (out): the `GValue` to store the result in
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Demarshals a value from a string.
*
@ -2064,7 +2061,7 @@ error:
* @type: the `GType` of the value
* @string: the string representation of the value
* @value: (out): the #GValue to store the result in
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Demarshals a value from a string.
*
@ -2732,7 +2729,7 @@ _gtk_builder_get_template_type (GtkBuilder *builder)
* @function_name: name of the function to look up
* @flags: closure creation flags
* @object: (nullable): Object to create the closure with
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Creates a closure to invoke the function called @function_name.
*

6
gtk/gtkbuilderparser.c
View File

@ -309,7 +309,7 @@ gtk_buildable_parse_context_pop (GtkBuildableParseContext *context)
* give the element_name as passed to those functions. For the parent
* elements, see gtk_buildable_parse_context_get_element_stack().
*
* Returns: (nullable): the name of the currently open element, or %NULL
* Returns: (nullable): the name of the currently open element
*/
const char *
gtk_buildable_parse_context_get_element (GtkBuildableParseContext *context)
@ -346,8 +346,8 @@ gtk_buildable_parse_context_get_element_stack (GtkBuildableParseContext *context
/**
* gtk_buildable_parse_context_get_position:
* @context: a #GtkBuildableParseContext
* @line_number: (out) (optional): return location for a line number, or %NULL
* @char_number: (out) (optional): return location for a char-on-line number, or %NULL
* @line_number: (out) (optional): return location for a line number
* @char_number: (out) (optional): return location for a char-on-line number
*
* Retrieves the current line number and the number of the character on
* that line. Intended for use in error messages; there are no strict

2
gtk/gtkbuilderscope.c
View File

@ -515,7 +515,7 @@ gtk_builder_cscope_add_callback_symbols (GtkBuilderCScope *self,
* gtk_builder_cscope_add_callback_symbol().
*
* Returns: (nullable) (transfer none): The callback symbol
* in @builder for @callback_name, or %NULL
* in @builder for @callback_name
*/
GCallback
gtk_builder_cscope_lookup_callback_symbol (GtkBuilderCScope *self,

2
gtk/gtkbutton.c
View File

@ -640,7 +640,7 @@ gtk_button_new_with_label (const char *label)
/**
* gtk_button_new_from_icon_name:
* @icon_name: (nullable): an icon name or %NULL
* @icon_name: (nullable): an icon name
*
* Creates a new button containing an icon from the current icon theme.
*

29
gtk/gtkcellarea.c
View File

@ -1883,11 +1883,11 @@ get_cell_by_position (GtkCellRenderer *renderer,
* @context: the #GtkCellAreaContext used to hold sizes for @area.
* @widget: the #GtkWidget that @area is rendering on
* @cell_area: the whole allocated area for @area in @widget
* for this row
* for this row
* @x: the x position
* @y: the y position
* @alloc_area: (out) (optional): where to store the inner allocated area of the
* returned cell renderer, or %NULL.
* returned cell renderer
*
* Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
* returns the full cell allocation for it inside @cell_area.
@ -1997,8 +1997,8 @@ gtk_cell_area_get_request_mode (GtkCellArea *area)
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to perform this request with
* @widget: the #GtkWidget where @area will be rendering
* @minimum_width: (out) (optional): location to store the minimum width, or %NULL
* @natural_width: (out) (optional): location to store the natural width, or %NULL
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
*
* Retrieves a cell area’s initial minimum and natural width.
*
@ -2028,8 +2028,8 @@ gtk_cell_area_get_preferred_width (GtkCellArea *area,
* @context: the #GtkCellAreaContext which has already been requested for widths.
* @widget: the #GtkWidget where @area will be rendering
* @width: the width for which to check the height of this area
* @minimum_height: (out) (optional): location to store the minimum height, or %NULL
* @natural_height: (out) (optional): location to store the natural height, or %NULL
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
*
* Retrieves a cell area’s minimum and natural height if it would be given
* the specified @width.
@ -2069,8 +2069,8 @@ gtk_cell_area_get_preferred_height_for_width (GtkCellArea *area,
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to perform this request with
* @widget: the #GtkWidget where @area will be rendering
* @minimum_height: (out) (optional): location to store the minimum height, or %NULL
* @natural_height: (out) (optional): location to store the natural height, or %NULL
* @minimum_height: (out) (optional): location to store the minimum height
* @natural_height: (out) (optional): location to store the natural height
*
* Retrieves a cell area’s initial minimum and natural height.
*
@ -2100,8 +2100,8 @@ gtk_cell_area_get_preferred_height (GtkCellArea *area,
* @context: the #GtkCellAreaContext which has already been requested for widths.
* @widget: the #GtkWidget where @area will be rendering
* @height: the height for which to check the width of this area
* @minimum_width: (out) (optional): location to store the minimum width, or %NULL
* @natural_width: (out) (optional): location to store the natural width, or %NULL
* @minimum_width: (out) (optional): location to store the minimum width
* @natural_width: (out) (optional): location to store the natural width
*
* Retrieves a cell area’s minimum and natural width if it would be given
* the specified @height.
@ -2381,8 +2381,7 @@ gtk_cell_area_class_install_cell_property (GtkCellAreaClass *aclass,
*
* Finds a cell property of a cell area class by name.
*
* Returns: (transfer none): the #GParamSpec of the child property
* or %NULL if @aclass has no child property with that name.
* Returns: (nullable) (transfer none): the #GParamSpec of the child property
*/
GParamSpec*
gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
@ -3073,7 +3072,7 @@ gtk_cell_area_get_focus_siblings (GtkCellArea *area,
* cell may have been a sibling.
*
* Returns: (nullable) (transfer none): the #GtkCellRenderer for which @renderer
* is a sibling, or %NULL.
* is a sibling
*/
GtkCellRenderer *
gtk_cell_area_get_focus_from_sibling (GtkCellArea *area,
@ -3438,8 +3437,8 @@ gtk_cell_area_inner_cell_area (GtkCellArea *area,
* @widget: the #GtkWidget that @area is rendering onto
* @for_size: the allocation contextual size to request for, or -1 if
* the base request for the orientation is to be returned.
* @minimum_size: (out) (optional): location to store the minimum size, or %NULL
* @natural_size: (out) (optional): location to store the natural size, or %NULL
* @minimum_size: (out) (optional): location to store the minimum size
* @natural_size: (out) (optional): location to store the natural size
*
* This is a convenience function for #GtkCellArea implementations
* to request size for cell renderers. It’s important to use this

4
gtk/gtkcellareacontext.c
View File

@ -507,8 +507,8 @@ gtk_cell_area_context_get_preferred_width_for_height (GtkCellAreaContext *contex
/**
* gtk_cell_area_context_get_allocation:
* @context: a #GtkCellAreaContext
* @width: (out) (optional): location to store the allocated width, or %NULL
* @height: (out) (optional): location to store the allocated height, or %NULL
* @width: (out) (optional): location to store the allocated width
* @height: (out) (optional): location to store the allocated height
*
* Fetches the current allocation size for @context.
*

5
gtk/gtkcelllayout.c
View File

@ -489,7 +489,7 @@ gtk_cell_layout_add_attribute (GtkCellLayout *cell_layout,
* gtk_cell_layout_set_cell_data_func:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
* @func: (nullable): the #GtkCellLayoutDataFunc to use, or %NULL
* @func: (nullable): the #GtkCellLayoutDataFunc to use
* @func_data: (closure): user data for @func
* @destroy: destroy notify for @func_data
*
@ -582,8 +582,7 @@ gtk_cell_layout_get_cells (GtkCellLayout *cell_layout)
* if called on a #GtkCellArea or might be %NULL if no #GtkCellArea
* is used by @cell_layout.
*
* Returns: (transfer none) (nullable): the cell area used by @cell_layout,
* or %NULL in case no cell area is used.
* Returns: (transfer none) (nullable): the cell area used by @cell_layout
*/
GtkCellArea *
gtk_cell_layout_get_area (GtkCellLayout *cell_layout)

36
gtk/gtkcellrenderer.c
View File

@ -877,8 +877,8 @@ gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_fixed_size:
* @cell: A #GtkCellRenderer
* @width: (out) (optional): location to fill in with the fixed width of the cell, or %NULL
* @height: (out) (optional): location to fill in with the fixed height of the cell, or %NULL
* @width: (out) (optional): location to fill in with the fixed width of the cell
* @height: (out) (optional): location to fill in with the fixed height of the cell
*
* Fills in @width and @height with the appropriate size of @cell.
**/
@ -943,8 +943,8 @@ gtk_cell_renderer_set_alignment (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_alignment:
* @cell: A #GtkCellRenderer
* @xalign: (out) (optional): location to fill in with the x alignment of the cell, or %NULL
* @yalign: (out) (optional): location to fill in with the y alignment of the cell, or %NULL
* @xalign: (out) (optional): location to fill in with the x alignment of the cell
* @yalign: (out) (optional): location to fill in with the y alignment of the cell
*
* Fills in @xalign and @yalign with the appropriate values of @cell.
**/
@ -1008,8 +1008,8 @@ gtk_cell_renderer_set_padding (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_padding:
* @cell: A #GtkCellRenderer
* @xpad: (out) (optional): location to fill in with the x padding of the cell, or %NULL
* @ypad: (out) (optional): location to fill in with the y padding of the cell, or %NULL
* @xpad: (out) (optional): location to fill in with the x padding of the cell
* @ypad: (out) (optional): location to fill in with the y padding of the cell
*
* Fills in @xpad and @ypad with the appropriate values of @cell.
**/
@ -1363,8 +1363,8 @@ gtk_cell_renderer_get_request_mode (GtkCellRenderer *cell)
* gtk_cell_renderer_get_preferred_width:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @minimum_size: (out) (optional): location to store the minimum size, or %NULL
* @natural_size: (out) (optional): location to store the natural size, or %NULL
* @minimum_size: (out) (optional): location to store the minimum size
* @natural_size: (out) (optional): location to store the natural size
*
* Retrieves a renderer’s natural size when rendered to @widget.
*/
@ -1409,8 +1409,8 @@ gtk_cell_renderer_get_preferred_width (GtkCellRenderer *cell,
* gtk_cell_renderer_get_preferred_height:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @minimum_size: (out) (optional): location to store the minimum size, or %NULL
* @natural_size: (out) (optional): location to store the natural size, or %NULL
* @minimum_size: (out) (optional): location to store the minimum size
* @natural_size: (out) (optional): location to store the natural size
*
* Retrieves a renderer’s natural size when rendered to @widget.
*/
@ -1456,8 +1456,8 @@ gtk_cell_renderer_get_preferred_height (GtkCellRenderer *cell,
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @height: the size which is available for allocation
* @minimum_width: (out) (optional): location for storing the minimum size, or %NULL
* @natural_width: (out) (optional): location for storing the preferred size, or %NULL
* @minimum_width: (out) (optional): location for storing the minimum size
* @natural_width: (out) (optional): location for storing the preferred size
*
* Retrieves a cell renderers’s minimum and natural width if it were rendered to
* @widget with the specified @height.
@ -1504,8 +1504,8 @@ gtk_cell_renderer_get_preferred_width_for_height (GtkCellRenderer *cell,
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @width: the size which is available for allocation
* @minimum_height: (out) (optional): location for storing the minimum size, or %NULL
* @natural_height: (out) (optional): location for storing the preferred size, or %NULL
* @minimum_height: (out) (optional): location for storing the minimum size
* @natural_height: (out) (optional): location for storing the preferred size
*
* Retrieves a cell renderers’s minimum and natural height if it were rendered to
* @widget with the specified @width.
@ -1551,8 +1551,8 @@ gtk_cell_renderer_get_preferred_height_for_width (GtkCellRenderer *cell,
* gtk_cell_renderer_get_preferred_size:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @minimum_size: (out) (optional): location for storing the minimum size, or %NULL
* @natural_size: (out) (optional): location for storing the natural size, or %NULL
* @minimum_size: (out) (optional): location for storing the minimum size
* @natural_size: (out) (optional): location for storing the natural size
*
* Retrieves the minimum and natural size of a cell taking
* into account the widget’s preference for height-for-width management.
@ -1643,8 +1643,8 @@ gtk_cell_renderer_get_aligned_area (GtkCellRenderer *cell,
/**
* gtk_cell_renderer_get_state:
* @cell: (nullable): a #GtkCellRenderer, or %NULL
* @widget: (nullable): a #GtkWidget, or %NULL
* @cell: (nullable): a #GtkCellRenderer
* @widget: (nullable): a #GtkWidget
* @cell_state: cell renderer state
*
* Translates the cell renderer state to #GtkStateFlags,

6
gtk/gtkcellview.c
View File

@ -1023,8 +1023,8 @@ gtk_cell_view_set_model (GtkCellView *cell_view,
* Returns the model for @cell_view. If no model is used %NULL is
* returned.
*
* Returns: (nullable) (transfer none): a #GtkTreeModel used or %NULL
**/
* Returns: (nullable) (transfer none): a #GtkTreeModel used
*/
GtkTreeModel *
gtk_cell_view_get_model (GtkCellView *cell_view)
{
@ -1077,7 +1077,7 @@ gtk_cell_view_set_displayed_row (GtkCellView *cell_view,
* displayed row. If no row is currently displayed,
* %NULL is returned.
*
* Returns: (nullable) (transfer full): the currently displayed row or %NULL
* Returns: (nullable) (transfer full): the currently displayed row
*/
GtkTreePath *
gtk_cell_view_get_displayed_row (GtkCellView *cell_view)

6
gtk/gtkcenterbox.c
View File

@ -245,7 +245,7 @@ gtk_center_box_new (void)
/**
* gtk_center_box_set_start_widget:
* @self: a `GtkCenterBox`
* @child: (nullable): the new start widget, or %NULL
* @child: (nullable): the new start widget
*
* Sets the start widget.
*
@ -271,7 +271,7 @@ gtk_center_box_set_start_widget (GtkCenterBox *self,
/**
* gtk_center_box_set_center_widget:
* @self: a `GtkCenterBox`
* @child: (nullable): the new center widget, or %NULL
* @child: (nullable): the new center widget
*
* Sets the center widget.
*
@ -297,7 +297,7 @@ gtk_center_box_set_center_widget (GtkCenterBox *self,
/**
* gtk_center_box_set_end_widget:
* @self: a `GtkCenterBox`
* @child: (nullable): the new end widget, or %NULL
* @child: (nullable): the new end widget
*
* Sets the end widget.
*

2
gtk/gtkcolorchooser.c
View File

@ -193,7 +193,7 @@ gtk_color_chooser_set_use_alpha (GtkColorChooser *chooser,
* be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns
* @colors_per_line: the number of colors to show in each row/column
* @n_colors: the total number of elements in @colors
* @colors: (nullable) (array length=n_colors): the colors of the palette, or %NULL
* @colors: (nullable) (array length=n_colors): the colors of the palette
*
* Adds a palette to the color chooser.
*

4
gtk/gtkcolorchooserdialog.c
View File

@ -276,8 +276,8 @@ gtk_color_chooser_dialog_iface_init (GtkColorChooserInterface *iface)
/**
* gtk_color_chooser_dialog_new:
* @title: (nullable): Title of the dialog, or %NULL
* @parent: (nullable): Transient parent of the dialog, or %NULL
* @title: (nullable): Title of the dialog
* @parent: (nullable): Transient parent of the dialog
*
* Creates a new `GtkColorChooserDialog`.
*

6
gtk/gtkcolumnview.c
View File

@ -1327,7 +1327,7 @@ gtk_column_view_init (GtkColumnView *self)
/**
* gtk_column_view_new:
* @model: (nullable) (transfer full): the list model to use, or %NULL
* @model: (nullable) (transfer full): the list model to use
*
* Creates a new `GtkColumnView`.
*
@ -1372,7 +1372,7 @@ gtk_column_view_get_model (GtkColumnView *self)
/**
* gtk_column_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a #GtkColumnView
* @model: (nullable) (transfer none): the model to use or %NULL for none
* @model: (nullable) (transfer none): the model to use
*
* Sets the model to use.
*
@ -1678,7 +1678,7 @@ gtk_column_view_get_sorter (GtkColumnView *self)
/**
* gtk_column_view_sort_by_column:
* @self: a `GtkColumnView`
* @column: (nullable): the `GtkColumnViewColumn` to sort by, or %NULL
* @column: (nullable): the `GtkColumnViewColumn` to sort by
* @direction: the direction to sort in
*
* Sets the sorting of the view.

6
gtk/gtkcolumnviewcolumn.c
View File

@ -655,7 +655,7 @@ gtk_column_view_column_get_factory (GtkColumnViewColumn *self)
/**
* gtk_column_view_column_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkColumnViewColumn`
* @factory: (nullable) (transfer none): the factory to use or %NULL for none
* @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items for this
* column.
@ -848,7 +848,7 @@ gtk_column_view_column_get_visible (GtkColumnViewColumn *self)
/**
* gtk_column_view_column_set_header_menu: (attributes org.gtk.Method.set_property=header-menu)
* @self: a `GtkColumnViewColumn`
* @menu: (nullable): a `GMenuModel`, or %NULL
* @menu: (nullable): a `GMenuModel`
*
* Sets the menu model that is used to create the context menu
* for the column header.
@ -876,7 +876,7 @@ gtk_column_view_column_set_header_menu (GtkColumnViewColumn *self,
* Gets the menu model that is used to create the context menu
* for the column header.
*
* Returns: (transfer none) (nullable): the #GMenuModel, or %NULL
* Returns: (transfer none) (nullable): the #GMenuModel
*/
GMenuModel *
gtk_column_view_column_get_header_menu (GtkColumnViewColumn *self)

10
gtk/gtkcombobox.c
View File

@ -2060,7 +2060,7 @@ gtk_combo_box_get_active_iter (GtkComboBox *combo_box,
/**
* gtk_combo_box_set_active_iter:
* @combo_box: A `GtkComboBox`
* @iter: (nullable): The `GtkTreeIter`, or %NULL
* @iter: (nullable): The `GtkTreeIter`
*
* Sets the current active item to be the one referenced by @iter.
*
@ -2569,8 +2569,8 @@ gtk_combo_box_get_row_separator_func (GtkComboBox *combo_box)
* gtk_combo_box_set_row_separator_func:
* @combo_box: a `GtkComboBox`
* @func: (nullable): a `GtkTreeViewRowSeparatorFunc`
* @data: (nullable): user data to pass to @func, or %NULL
* @destroy: (nullable): destroy notifier for @data, or %NULL
* @data: (nullable): user data to pass to @func
* @destroy: (nullable): destroy notifier for @data
*
* Sets the row separator function, which is used to determine
* whether a row should be drawn as a separator.
@ -2848,7 +2848,7 @@ gtk_combo_box_get_id_column (GtkComboBox *combo_box)
* not set, or if no row is active, or if the active row has a %NULL
* ID value, then %NULL is returned.
*
* Returns: (nullable): the ID of the active row, or %NULL
* Returns: (nullable): the ID of the active row
*/
const char *
gtk_combo_box_get_active_id (GtkComboBox *combo_box)
@ -2887,7 +2887,7 @@ gtk_combo_box_get_active_id (GtkComboBox *combo_box)
/**
* gtk_combo_box_set_active_id: (attributes org.gtk.Method.set_property=active-id)
* @combo_box: a `GtkComboBox`
* @active_id: (nullable): the ID of the row to select, or %NULL
* @active_id: (nullable): the ID of the row to select
*
* Changes the active row of @combo_box to the one that has an ID equal to
* @active_id.

6
gtk/gtkcomboboxtext.c
View File

@ -431,7 +431,7 @@ gtk_combo_box_text_insert_text (GtkComboBoxText *combo_box,
/**
* gtk_combo_box_text_append:
* @combo_box: A `GtkComboBoxText`
* @id: (nullable): a string ID for this value, or %NULL
* @id: (nullable): a string ID for this value
* @text: A string
*
* Appends @text to the list of strings stored in @combo_box.
@ -452,7 +452,7 @@ gtk_combo_box_text_append (GtkComboBoxText *combo_box,
/**
* gtk_combo_box_text_prepend:
* @combo_box: A `GtkComboBox`
* @id: (nullable): a string ID for this value, or %NULL
* @id: (nullable): a string ID for this value
* @text: a string
*
* Prepends @text to the list of strings stored in @combo_box.
@ -475,7 +475,7 @@ gtk_combo_box_text_prepend (GtkComboBoxText *combo_box,
* gtk_combo_box_text_insert:
* @combo_box: A `GtkComboBoxText`
* @position: An index to insert @text
* @id: (nullable): a string ID for this value, or %NULL
* @id: (nullable): a string ID for this value
* @text: A string to display
*
* Inserts @text at @position in the list of strings stored in @combo_box.

2
gtk/gtkcsslookup.c
View File

@ -51,7 +51,7 @@ _gtk_css_lookup_is_missing (const GtkCssLookup *lookup,
* _gtk_css_lookup_set:
* @lookup: the lookup
* @id: id of the property to set, see _gtk_style_property_get_id()
* @section: (nullable): The @section the value was defined in or %NULL
* @section: (nullable): The @section the value was defined in
* @value: the “cascading value” to use
*
* Sets the @value for a given @id. No value may have been set for @id

4
gtk/gtkcustompaperunixdialog.c
View File

@ -385,8 +385,8 @@ gtk_custom_paper_unix_dialog_finalize (GObject *object)
/**
* gtk_custom_paper_unix_dialog_new:
* @title: (nullable): the title of the dialog, or %NULL
* @parent: (nullable): transient parent of the dialog, or %NULL
* @title: (nullable): the title of the dialog
* @parent: (nullable): transient parent of the dialog
*
* Creates a new custom paper dialog.
*

6
gtk/gtkdialog.c
View File

@ -724,10 +724,10 @@ gtk_dialog_new_empty (const char *title,
/**
* gtk_dialog_new_with_buttons:
* @title: (nullable): Title of the dialog, or %NULL
* @parent: (nullable): Transient parent of the dialog, or %NULL
* @title: (nullable): Title of the dialog
* @parent: (nullable): Transient parent of the dialog
* @flags: from `GtkDialogFlags`
* @first_button_text: (nullable): text to go in first button, or %NULL
* @first_button_text: (nullable): text to go in first button
* @...: response ID for first button, then additional buttons, ending with %NULL
*
* Creates a new `GtkDialog` with the given title and transient parent.

4
gtk/gtkdragicon.c
View File

@ -457,7 +457,7 @@ gtk_drag_icon_set_from_paintable (GdkDrag *drag,
/**
* gtk_drag_icon_set_child: (attributes org.gtk.Method.set_property=child)
* @self: a `GtkDragIcon`
* @child: (nullable): a `GtkWidget` or %NULL
* @child: (nullable): a `GtkWidget`
*
* Sets the widget to display as the drag icon.
*/
@ -491,7 +491,7 @@ gtk_drag_icon_set_child (GtkDragIcon *self,
*
* Gets the widget currently used as drag icon.
*
* Returns: (nullable) (transfer none): The drag icon or %NULL if none.
* Returns: (nullable) (transfer none): The drag icon
**/
GtkWidget *
gtk_drag_icon_get_child (GtkDragIcon *self)

8
gtk/gtkdragsource.c
View File

@ -359,7 +359,7 @@ gtk_drag_source_class_init (GtkDragSourceClass *class)
* the [property@Gtk.DragSource:content] property, so if you set up that
* property ahead of time, you don't need to connect to this signal.
*
* Returns: (transfer full) (nullable): a `GdkContentProvider`, or %NULL
* Returns: (transfer full) (nullable): a `GdkContentProvider`
*/
signals[PREPARE] =
g_signal_new (I_("prepare"),
@ -635,7 +635,7 @@ gtk_drag_source_get_content (GtkDragSource *source)
/**
* gtk_drag_source_set_content: (attributes org.gtk.Method.set_property=content)
* @source: a `GtkDragSource`
* @content: (nullable): a `GdkContentProvider`, or %NULL
* @content: (nullable): a `GdkContentProvider`
*
* Sets a content provider on a `GtkDragSource`.
*
@ -708,7 +708,7 @@ gtk_drag_source_set_actions (GtkDragSource *source,
/**
* gtk_drag_source_set_icon:
* @source: a `GtkDragSource`
* @paintable: (nullable): the #GdkPaintable to use as icon, or %NULL
* @paintable: (nullable): the #GdkPaintable to use as icon
* @hot_x: the hotspot X coordinate on the icon
* @hot_y: the hotspot Y coordinate on the icon
*
@ -744,7 +744,7 @@ gtk_drag_source_set_icon (GtkDragSource *source,
* Returns the underlying `GdkDrag` object for an ongoing drag.
*
* Returns: (nullable) (transfer none): the `GdkDrag` of the current
* drag operation, or %NULL
* drag operation
*/
GdkDrag *
gtk_drag_source_get_drag (GtkDragSource *source)

2
gtk/gtkdropcontrollermotion.c
View File

@ -371,7 +371,7 @@ gtk_drop_controller_motion_contains_pointer (GtkDropControllerMotion *self)
* over the widget of @self.
*
* Returns: (transfer none) (nullable): The `GdkDrop` currently
* happening within @self or %NULL if none
* happening within @self
*/
GdkDrop *
gtk_drop_controller_motion_get_drop (GtkDropControllerMotion *self)

14
gtk/gtkdropdown.c
View File

@ -662,8 +662,8 @@ gtk_drop_down_init (GtkDropDown *self)
/**
* gtk_drop_down_new:
* @model: (transfer full) (nullable): the model to use or %NULL for none
* @expression: (transfer full) (nullable): the expression to use or %NULL for none
* @model: (transfer full) (nullable): the model to use
* @expression: (transfer full) (nullable): the expression to use
*
* Creates a new `GtkDropDown`.
*
@ -724,7 +724,7 @@ gtk_drop_down_get_model (GtkDropDown *self)
/**
* gtk_drop_down_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkDropDown`
* @model: (nullable) (transfer none): the model to use or %NULL for none
* @model: (nullable) (transfer none): the model to use
*
* Sets the `GListModel` to use.
*/
@ -798,7 +798,7 @@ gtk_drop_down_get_factory (GtkDropDown *self)
/**
* gtk_drop_down_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkDropDown`
* @factory: (nullable) (transfer none): the factory to use or %NULL for none
* @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items.
**/
@ -838,7 +838,7 @@ gtk_drop_down_get_list_factory (GtkDropDown *self)
/**
* gtk_drop_down_set_list_factory: (attributes org.gtk.Method.set_property=list-factory)
* @self: a `GtkDropDown`
* @factory: (nullable) (transfer none): the factory to use or %NULL for none
* @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items in the popup.
*/
@ -968,7 +968,7 @@ gtk_drop_down_get_enable_search (GtkDropDown *self)
/**
* gtk_drop_down_set_expression: (attributes org.gtk.Method.set_property=expression)
* @self: a `GtkDropDown`
* @expression: (nullable): a `GtkExpression`, or %NULL
* @expression: (nullable): a `GtkExpression`
*
* Sets the expression that gets evaluated to obtain strings from items.
*
@ -1005,7 +1005,7 @@ gtk_drop_down_set_expression (GtkDropDown *self,
*
* See [method@Gtk.DropDown.set_expression].
*
* Returns: (nullable) (transfer none): a `GtkExpression` or %NULL
* Returns: (nullable) (transfer none): a `GtkExpression`
*/
GtkExpression *
gtk_drop_down_get_expression (GtkDropDown *self)

4
gtk/gtkeditable.c
View File

@ -666,8 +666,8 @@ gtk_editable_get_position (GtkEditable *editable)
/**
* gtk_editable_get_selection_bounds:
* @editable: a `GtkEditable`
* @start_pos: (out) (optional): location to store the starting position, or %NULL
* @end_pos: (out) (optional): location to store the end position, or %NULL
* @start_pos: (out) (optional): location to store the starting position
* @end_pos: (out) (optional): location to store the end position
*
* Retrieves the selection bound of the editable.
*

37
gtk/gtkentry.c
View File

@ -2467,7 +2467,7 @@ gtk_entry_get_alignment (GtkEntry *entry)
* gtk_entry_set_icon_from_paintable:
* @entry: a `GtkEntry`
* @icon_pos: Icon position
* @paintable: (nullable): A `GdkPaintable`, or %NULL
* @paintable: (nullable): A `GdkPaintable`
*
* Sets the icon shown in the specified position using a `GdkPaintable`.
*
@ -2522,7 +2522,7 @@ gtk_entry_set_icon_from_paintable (GtkEntry *entry,
* gtk_entry_set_icon_from_icon_name:
* @entry: A `GtkEntry`
* @icon_pos: The position at which to set the icon
* @icon_name: (nullable): An icon name, or %NULL
* @icon_name: (nullable): An icon name
*
* Sets the icon shown in the entry at the specified position
* from the current icon theme.
@ -2578,7 +2578,7 @@ gtk_entry_set_icon_from_icon_name (GtkEntry *entry,
* gtk_entry_set_icon_from_gicon:
* @entry: A `GtkEntry`
* @icon_pos: The position at which to set the icon
* @icon: (nullable): The icon to set, or %NULL
* @icon: (nullable): The icon to set
*
* Sets the icon shown in the entry at the specified position
* from the current icon theme.
@ -2697,7 +2697,7 @@ gtk_entry_get_icon_activatable (GtkEntry *entry,
*
* If no `GdkPaintable` was used for the icon, %NULL is returned.
*
* Returns: (transfer none) (nullable): A `GdkPaintable`, or %NULL
* Returns: (transfer none) (nullable): A `GdkPaintable`
* if no icon is set for this position or the icon set is not
* a `GdkPaintable`.
*/
@ -2729,8 +2729,7 @@ gtk_entry_get_icon_paintable (GtkEntry *entry,
* %NULL will be returned if there is no icon or if the icon was
* set by some other method (e.g., by `GdkPaintable` or icon name).
*
* Returns: (transfer none) (nullable): A `GIcon`, or %NULL if no
* icon is set or if the icon is not a `GIcon`
* Returns: (transfer none) (nullable): A `GIcon`
*/
GIcon *
gtk_entry_get_icon_gicon (GtkEntry *entry,
@ -2760,8 +2759,7 @@ gtk_entry_get_icon_gicon (GtkEntry *entry,
* %NULL is returned if there is no icon or if the icon was set
* by some other method (e.g., by `GdkPaintable` or gicon).
*
* Returns: (nullable): An icon name, or %NULL if no icon is set
* or if the icon wasn’t set from an icon name
* Returns: (nullable): An icon name
*/
const char *
gtk_entry_get_icon_name (GtkEntry *entry,
@ -3061,8 +3059,7 @@ ensure_has_tooltip (GtkEntry *entry)
* Gets the contents of the tooltip on the icon at the specified
* position in @entry.
*
* Returns: (nullable): the tooltip text, or %NULL. Free the returned
* string with g_free() when done.
* Returns: (nullable) (transfer full): the tooltip text
*/
char *
gtk_entry_get_icon_tooltip_text (GtkEntry *entry,
@ -3091,8 +3088,7 @@ gtk_entry_get_icon_tooltip_text (GtkEntry *entry,
* gtk_entry_set_icon_tooltip_text:
* @entry: a `GtkEntry`
* @icon_pos: the icon position
* @tooltip: (nullable): the contents of the tooltip for the
* icon, or %NULL
* @tooltip: (nullable): the contents of the tooltip for the icon
*
* Sets @tooltip as the contents of the tooltip for the icon
* at the specified position.
@ -3152,8 +3148,7 @@ gtk_entry_set_icon_tooltip_text (GtkEntry *entry,
* Gets the contents of the tooltip on the icon at the specified
* position in @entry.
*
* Returns: (nullable): the tooltip text, or %NULL. Free the
* returned string with g_free() when done.
* Returns: (nullable) (transfer full): the tooltip text
*/
char *
gtk_entry_get_icon_tooltip_markup (GtkEntry *entry,
@ -3177,8 +3172,7 @@ gtk_entry_get_icon_tooltip_markup (GtkEntry *entry,
* gtk_entry_set_icon_tooltip_markup:
* @entry: a `GtkEntry`
* @icon_pos: the icon position
* @tooltip: (nullable): the contents of the tooltip for the
* icon, or %NULL
* @tooltip: (nullable): the contents of the tooltip for the icon
*
* Sets @tooltip as the contents of the tooltip for the icon at
* the specified position.
@ -3261,7 +3255,7 @@ gtk_entry_query_tooltip (GtkWidget *widget,
/**
* gtk_entry_set_completion: (attributes org.gtk.Method.set_property=completion)
* @entry: A `GtkEntry`
* @completion: (nullable): The `GtkEntryCompletion` or %NULL
* @completion: (nullable): The `GtkEntryCompletion`
*
* Sets @completion to be the auxiliary completion object
* to use with @entry.
@ -3480,8 +3474,7 @@ gtk_entry_progress_pulse (GtkEntry *entry)
/**
* gtk_entry_set_placeholder_text: (attributes org.gtk.Method.set_property=placeholder-text)
* @entry: a `GtkEntry`
* @text: (nullable): a string to be displayed when @entry is
* empty and unfocused, or %NULL
* @text: (nullable): a string to be displayed when @entry is empty and unfocused
*
* Sets text to be displayed in @entry when it is empty.
*
@ -3634,8 +3627,7 @@ gtk_entry_set_attributes (GtkEntry *entry,
*
* See [method@Gtk.Entry.set_attributes].
*
* Returns: (transfer none) (nullable): the attribute list,
* or %NULL if none was set.
* Returns: (transfer none) (nullable): the attribute list
*/
PangoAttrList *
gtk_entry_get_attributes (GtkEntry *entry)
@ -3676,8 +3668,7 @@ gtk_entry_set_tabs (GtkEntry *entry,
*
* See [method@Gtk.Entry.set_tabs].
*
* Returns: (nullable) (transfer none): the tabstops,
* or %NULL if none was set.
* Returns: (nullable) (transfer none): the tabstops
*/
PangoTabArray *

2
gtk/gtkentrybuffer.c
View File

@ -424,7 +424,7 @@ gtk_entry_buffer_class_init (GtkEntryBufferClass *klass)
/**
* gtk_entry_buffer_new:
* @initial_chars: (nullable): initial buffer text, or %NULL
* @initial_chars: (nullable): initial buffer text
* @n_initial_chars: number of characters in @initial_chars, or -1
*
* Create a new `GtkEntryBuffer` object.

5
gtk/gtkentrycompletion.c
View File

@ -927,8 +927,7 @@ gtk_entry_completion_set_model (GtkEntryCompletion *completion,
*
* Returns %NULL if the model is unset.
*
* Returns: (nullable) (transfer none): A `GtkTreeModel`, or %NULL if none
* is currently being used
* Returns: (nullable) (transfer none): A `GtkTreeModel`
*/
GtkTreeModel *
gtk_entry_completion_get_model (GtkEntryCompletion *completion)
@ -1248,7 +1247,7 @@ gtk_entry_completion_cursor_on_match (GtkEntryCompletion *completion,
* see [method@Gtk.EntryCompletion.set_text_column] for details.
*
* Returns: (nullable) (transfer full): The common prefix all rows
* starting with @key or %NULL if no row matches @key.
* starting with @key
*/
char *
gtk_entry_completion_compute_prefix (GtkEntryCompletion *completion,

3
gtk/gtkexpander.c
View File

@ -1134,8 +1134,7 @@ gtk_expander_set_label_widget (GtkExpander *expander,
*
* Retrieves the label widget for the frame.
*
* Returns: (nullable) (transfer none): the label widget,
* or %NULL if there is none
* Returns: (nullable) (transfer none): the label widget
*/
GtkWidget *
gtk_expander_get_label_widget (GtkExpander *expander)

10
gtk/gtkfilechooser.c
View File

@ -370,7 +370,7 @@ gtk_file_chooser_unselect_all (GtkFileChooser *chooser)
* gtk_file_chooser_set_current_folder:
* @chooser: a `GtkFileChooser`
* @file: the `GFile` for the new folder
* @error: location to store error, or %NULL.
* @error: location to store error
*
* Sets the current folder for @chooser from a #GFile.
*
@ -450,7 +450,7 @@ gtk_file_chooser_get_files (GtkFileChooser *chooser)
* gtk_file_chooser_set_file:
* @chooser: a `GtkFileChooser`
* @file: the `GFile` to set as current
* @error: (nullable): location to store the error, or %NULL to ignore errors.
* @error: (nullable): location to store the error
*
* Sets @file as the current filename for the file chooser.
*
@ -546,7 +546,7 @@ gtk_file_chooser_get_file (GtkFileChooser *chooser)
* gtk_file_chooser_add_shortcut_folder:
* @chooser: a `GtkFileChooser`
* @folder: a `GFile` for the folder to add
* @error: location to store error, or %NULL
* @error: location to store error
*
* Adds a folder to be displayed with the shortcut folders
* in a file chooser.
@ -569,7 +569,7 @@ gtk_file_chooser_add_shortcut_folder (GtkFileChooser *chooser,
* gtk_file_chooser_remove_shortcut_folder:
* @chooser: a `GtkFileChooser`
* @folder: a `GFile` for the folder to remove
* @error: location to store error, or %NULL
* @error: location to store error
*
* Removes a folder from the shortcut folders in a file chooser.
*
@ -679,7 +679,7 @@ gtk_file_chooser_set_filter (GtkFileChooser *chooser,
*
* Gets the current filter.
*
* Returns: (nullable) (transfer none): the current filter, or %NULL
* Returns: (nullable) (transfer none): the current filter
*/
GtkFileFilter *
gtk_file_chooser_get_filter (GtkFileChooser *chooser)

6
gtk/gtkfilechooserdialog.c
View File

@ -707,10 +707,10 @@ gtk_file_chooser_dialog_new_valist (const char *title,
/**
* gtk_file_chooser_dialog_new:
* @title: (nullable): Title of the dialog, or %NULL
* @parent: (nullable): Transient parent of the dialog, or %NULL
* @title: (nullable): Title of the dialog
* @parent: (nullable): Transient parent of the dialog
* @action: Open or save mode for the dialog
* @first_button_text: (nullable): text to go in the first button, or %NULL
* @first_button_text: (nullable): text to go in the first button
* @...: response ID for the first button, then additional (button, id) pairs, ending with %NULL
*
* Creates a new `GtkFileChooserDialog`.

7
gtk/gtkfilechooserentry.c
View File

@ -859,10 +859,9 @@ _gtk_file_chooser_entry_set_base_folder (GtkFileChooserEntry *chooser_entry,
* be different. If the user has entered unparsable text, or text which
* the entry cannot handle, this will return %NULL.
*
* Returns: (nullable): the file for the current folder or %NULL if the
* current folder can not be determined. Unref the file with
* g_object_unref() after use.
**/
* Returns: (nullable) (transfer full): the file for the current folder
* or %NULL if the current folder can not be determined
*/
GFile *
_gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
{

14
gtk/gtkfilechoosernative.c
View File

@ -217,8 +217,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkFileChooserNative, gtk_file_chooser_native, GTK_TYPE
*
* Retrieves the custom label text for the accept button.
*
* Returns: (nullable): The custom label, or %NULL for the default.
* This string is owned by GTK and should not be modified or freed
* Returns: (nullable): The custom label
*/
const char *
gtk_file_chooser_native_get_accept_label (GtkFileChooserNative *self)
@ -231,7 +230,7 @@ gtk_file_chooser_native_get_accept_label (GtkFileChooserNative *self)
/**
* gtk_file_chooser_native_set_accept_label: (attributes org.gtk.Method.set_property=accept-label)
* @self: a `GtkFileChooserNative`
* @accept_label: (nullable): custom label or %NULL for the default
* @accept_label: (nullable): custom label
*
* Sets the custom label text for the accept button.
*
@ -260,8 +259,7 @@ gtk_file_chooser_native_set_accept_label (GtkFileChooserNative *self,
*
* Retrieves the custom label text for the cancel button.
*
* Returns: (nullable): The custom label, or %NULL for the default.
* This string is owned by GTK and should not be modified or freed
* Returns: (nullable): The custom label
*/
const char *
gtk_file_chooser_native_get_cancel_label (GtkFileChooserNative *self)
@ -274,7 +272,7 @@ gtk_file_chooser_native_get_cancel_label (GtkFileChooserNative *self)
/**
* gtk_file_chooser_native_set_cancel_label: (attributes org.gtk.Method.set_property=cancel-label)
* @self: a `GtkFileChooserNative`
* @cancel_label: (nullable): custom label or %NULL for the default
* @cancel_label: (nullable): custom label
*
* Sets the custom label text for the cancel button.
*
@ -520,8 +518,8 @@ gtk_file_chooser_native_init (GtkFileChooserNative *self)
/**
* gtk_file_chooser_native_new:
* @title: (nullable): Title of the native, or %NULL
* @parent: (nullable): Transient parent of the native, or %NULL
* @title: (nullable): Title of the native
* @parent: (nullable): Transient parent of the native
* @action: Open or save mode for the dialog
* @accept_label: (nullable): text to go in the accept button, or %NULL for the default
* @cancel_label: (nullable): text to go in the cancel button, or %NULL for the default

4
gtk/gtkfilefilter.c
View File

@ -473,9 +473,7 @@ gtk_file_filter_set_name (GtkFileFilter *filter,
*
* See [method@Gtk.FileFilter.set_name].
*
* Returns: (nullable): The human-readable name of the filter,
* or %NULL. This value is owned by GTK and must not
* be modified or freed.
* Returns: (nullable): The human-readable name of the filter
*/
const char *
gtk_file_filter_get_name (GtkFileFilter *filter)

2
gtk/gtkfilesystemmodel.c
View File

@ -1662,7 +1662,7 @@ _gtk_file_system_model_get_file (GtkFileSystemModel *model,
*
* Returns: a pointer to the actual value as stored in @model or %NULL
* if no value available yet
**/
*/
const GValue *
_gtk_file_system_model_get_value (GtkFileSystemModel *model,
GtkTreeIter * iter,

6
gtk/gtkfilterlistmodel.c
View File

@ -610,8 +610,8 @@ gtk_filter_list_model_init (GtkFilterListModel *self)
/**
* gtk_filter_list_model_new:
* @model: (nullable) (transfer full): the model to sort, or %NULL
* @filter: (nullable) (transfer full): filter or %NULL to not filter items
* @model: (nullable) (transfer full): the model to sort
* @filter: (nullable) (transfer full): filter
*
* Creates a new `GtkFilterListModel` that will filter @model using the given
* @filter.
@ -642,7 +642,7 @@ gtk_filter_list_model_new (GListModel *model,
/**
* gtk_filter_list_model_set_filter: (attributes org.gtk.Method.set_property=filter)
* @self: a `GtkFilterListModel`
* @filter: (nullable) (transfer none): filter to use or %NULL to not filter items
* @filter: (nullable) (transfer none): filter to use
*
* Sets the filter used to filter items.
**/

5
gtk/gtkfixed.c
View File

@ -273,7 +273,7 @@ gtk_fixed_get_child_position (GtkFixed *fixed,
* gtk_fixed_set_child_transform:
* @fixed: a `GtkFixed`
* @widget: a `GtkWidget`, child of @fixed
* @transform: (nullable): the transformation assigned to @widget or %NULL
* @transform: (nullable): the transformation assigned to @widget
* to reset @widget's transform
*
* Sets the transformation for @widget.
@ -306,8 +306,7 @@ gtk_fixed_set_child_transform (GtkFixed *fixed,
* Retrieves the transformation for @widget set using
* gtk_fixed_set_child_transform().
*
* Returns: (transfer none) (nullable): a `GskTransform` or %NULL
* in case no transform has been set on @widget
* Returns: (transfer none) (nullable): a `GskTransform`
*/
GskTransform *
gtk_fixed_get_child_transform (GtkFixed *fixed,

2
gtk/gtkflattenlistmodel.c
View File

@ -447,7 +447,7 @@ gtk_flatten_list_model_new (GListModel *model)
/**
* gtk_flatten_list_model_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkFlattenListModel`
* @model: (nullable) (transfer none): the new model or %NULL
* @model: (nullable) (transfer none): the new model
*
* Sets a new model to be flattened.
*/

15
gtk/gtkfontchooser.c
View File

@ -181,8 +181,7 @@ gtk_font_chooser_default_init (GtkFontChooserInterface *iface)
* If the selected font is not installed, returns %NULL.
*
* Returns: (nullable) (transfer none): A `PangoFontFamily` representing the
* selected font family, or %NULL. The returned object is owned by @fontchooser
* and must not be modified or freed.
* selected font family
*/
PangoFontFamily *
gtk_font_chooser_get_font_family (GtkFontChooser *fontchooser)
@ -202,8 +201,7 @@ gtk_font_chooser_get_font_family (GtkFontChooser *fontchooser)
* If the selected font is not installed, returns %NULL.
*
* Returns: (nullable) (transfer none): A `PangoFontFace` representing the
* selected font group details, or %NULL. The returned object is owned by
* @fontchooser and must not be modified or freed.
* selected font group details
*/
PangoFontFace *
gtk_font_chooser_get_font_face (GtkFontChooser *fontchooser)
@ -246,8 +244,7 @@ gtk_font_chooser_get_font_size (GtkFontChooser *fontchooser)
* font descriptions.
*
* Returns: (nullable) (transfer full): A string with the name
* of the current font, or %NULL if no font is selected. You must
* free this string with g_free().
* of the current font
*/
char *
gtk_font_chooser_get_font (GtkFontChooser *fontchooser)
@ -295,7 +292,7 @@ gtk_font_chooser_set_font (GtkFontChooser *fontchooser,
* font descriptions.
*
* Returns: (nullable) (transfer full): A `PangoFontDescription` for the
* current font, or %NULL if no font is selected.
* current font
*/
PangoFontDescription *
gtk_font_chooser_get_font_desc (GtkFontChooser *fontchooser)
@ -405,7 +402,7 @@ gtk_font_chooser_set_show_preview_entry (GtkFontChooser *fontchooser,
/**
* gtk_font_chooser_set_filter_func:
* @fontchooser: a `GtkFontChooser`
* @filter: (nullable): a `GtkFontFilterFunc`, or %NULL
* @filter: (nullable): a `GtkFontFilterFunc`
* @user_data: (closure): data to pass to @filter
* @destroy: function to call to free @data when it is no longer needed
*
@ -484,7 +481,7 @@ gtk_font_chooser_set_font_map (GtkFontChooser *fontchooser,
* Gets the custom font map of this font chooser widget,
* or %NULL if it does not have one.
*
* Returns: (nullable) (transfer full): a `PangoFontMap`, or %NULL
* Returns: (nullable) (transfer full): a `PangoFontMap`
*/
PangoFontMap *
gtk_font_chooser_get_font_map (GtkFontChooser *fontchooser)

4
gtk/gtkfontchooserdialog.c
View File

@ -281,8 +281,8 @@ gtk_font_chooser_dialog_init (GtkFontChooserDialog *dialog)
/**
* gtk_font_chooser_dialog_new:
* @title: (nullable): Title of the dialog, or %NULL
* @parent: (nullable): Transient parent of the dialog, or %NULL
* @title: (nullable): Title of the dialog
* @parent: (nullable): Transient parent of the dialog
*
* Creates a new `GtkFontChooserDialog`.
*

3
gtk/gtkframe.c
View File

@ -448,8 +448,7 @@ gtk_frame_set_label_widget (GtkFrame *frame,
*
* Retrieves the label widget for the frame.
*
* Returns: (nullable) (transfer none): the label widget, or %NULL if
* there is none.
* Returns: (nullable) (transfer none): the label widget
*/
GtkWidget *
gtk_frame_get_label_widget (GtkFrame *frame)

4
gtk/gtkgesture.c
View File

@ -919,7 +919,7 @@ gtk_gesture_init (GtkGesture *gesture)
*
* This returns %NULL if the gesture is not being interacted.
*
* Returns: (nullable) (transfer none): a `GdkDevice`, or %NULL
* Returns: (nullable) (transfer none): a `GdkDevice`
*/
GdkDevice *
gtk_gesture_get_device (GtkGesture *gesture)
@ -1450,7 +1450,7 @@ _gtk_gesture_check (GtkGesture *gesture)
/**
* gtk_gesture_handles_sequence:
* @gesture: a `GtkGesture`
* @sequence: (nullable): a `GdkEventSequence` or %NULL
* @sequence: (nullable): a `GdkEventSequence`
*
* Returns %TRUE if @gesture is currently handling events
* corresponding to @sequence.

2
gtk/gtkglarea.c
View File

@ -1019,7 +1019,7 @@ gtk_gl_area_set_error (GtkGLArea *area,
*
* Gets the current error set on the @area.
*
* Returns: (nullable) (transfer none): the #GError or %NULL
* Returns: (nullable) (transfer none): the #GError
*/
GError *
gtk_gl_area_get_error (GtkGLArea *area)

2
gtk/gtkgrid.c
View File

@ -682,7 +682,7 @@ gtk_grid_attach_next_to (GtkGrid *grid,
* Gets the child of @grid whose area covers the grid
* cell at @column, @row.
*
* Returns: (transfer none) (nullable): the child at the given position, or %NULL
* Returns: (transfer none) (nullable): the child at the given position
*/
GtkWidget *
gtk_grid_get_child_at (GtkGrid *grid,

10
gtk/gtkgridview.c
View File

@ -214,7 +214,7 @@ cell_augment (GtkRbTree *tree,
* In particular that means that for an empty grid, %NULL is returned
* for any value.
*
* Returns: (nullable): The first cell at offset y or %NULL if none
* Returns: (nullable): The first cell at offset y
**/
static Cell *
gtk_grid_view_get_cell_at_y (GtkGridView *self,
@ -1185,8 +1185,8 @@ gtk_grid_view_init (GtkGridView *self)
/**
* gtk_grid_view_new:
* @model: (nullable) (transfer full): the model to use, or %NULL
* @factory: (nullable) (transfer full): The factory to populate items with, or %NULL
* @model: (nullable) (transfer full): the model to use
* @factory: (nullable) (transfer full): The factory to populate items with
*
* Creates a new `GtkGridView` that uses the given @factory for
* mapping items to widgets.
@ -1240,7 +1240,7 @@ gtk_grid_view_get_model (GtkGridView *self)
/**
* gtk_grid_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkGridView`
* @model: (nullable) (transfer none): the model to use or %NULL for none
* @model: (nullable) (transfer none): the model to use
*
* Sets the imodel to use.
*
@ -1282,7 +1282,7 @@ gtk_grid_view_get_factory (GtkGridView *self)
/**
* gtk_grid_view_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkGridView`
* @factory: (nullable) (transfer none): the factory to use or %NULL for none
* @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items.
*/

6
gtk/gtkheaderbar.c
View File

@ -338,8 +338,7 @@ gtk_header_bar_set_title_widget (GtkHeaderBar *bar,
*
* See [method@Gtk.HeaderBar.set_title_widget].
*
* Returns: (nullable) (transfer none): the title widget
* of the header, or %NULL if none has been set explicitly.
* Returns: (nullable) (transfer none): the title widget of the header
*/
GtkWidget *
gtk_header_bar_get_title_widget (GtkHeaderBar *bar)
@ -769,8 +768,7 @@ gtk_header_bar_set_show_title_buttons (GtkHeaderBar *bar,
/**
* gtk_header_bar_set_decoration_layout: (attributes org.gtk.Method.set_property=decoration-layout)
* @bar: a `GtkHeaderBar`
* @layout: (nullable): a decoration layout, or %NULL to
* unset the layout
* @layout: (nullable): a decoration layout, or %NULL to unset the layout
*
* Sets the decoration layout for this header bar.
*

9
gtk/gtkicontheme.c
View File

@ -1484,8 +1484,7 @@ gtk_icon_theme_set_search_path (GtkIconTheme *self,
* See [method@Gtk.IconTheme.set_search_path].
*
* Returns: (transfer full) (array zero-terminated=1) (element-type filename) (nullable):
* a list of icon theme path directories or %NULL.
* The returned value should be freed with g_strfreev().
* a list of icon theme path directories
*/
char **
gtk_icon_theme_get_search_path (GtkIconTheme *self)
@ -1581,8 +1580,7 @@ gtk_icon_theme_set_resource_path (GtkIconTheme *self,
* See [method@Gtk.IconTheme.set_resource_path].
*
* Returns: (transfer full) (array zero-terminated=1) (element-type utf8) (nullable):
* A list of resource paths or %NULL.
* The returned value should be freed with g_strfreev().
* A list of resource paths
*/
char **
gtk_icon_theme_get_resource_path (GtkIconTheme *self)
@ -3679,8 +3677,7 @@ new_resource_file (const char *filename)
*
* Returns %NULL if the icon was not loaded from a file.
*
* Returns: (nullable) (transfer full): the #GFile for the icon, or %NULL.
* Free with g_object_unref().
* Returns: (nullable) (transfer full): the #GFile for the icon
*/
GFile *
gtk_icon_paintable_get_file (GtkIconPaintable *icon)

17
gtk/gtkiconview.c
View File

@ -1955,7 +1955,7 @@ gtk_icon_view_remove_editable (GtkCellArea *area,
* gtk_icon_view_set_cursor:
* @icon_view: A #GtkIconView
* @path: A #GtkTreePath
* @cell: (nullable): One of the cell renderers of @icon_view, or %NULL
* @cell: (nullable): One of the cell renderers of @icon_view
* @start_editing: %TRUE if the specified cell should start being edited.
*
* Sets the current keyboard focus to be at @path, and selects it. This is
@ -4110,9 +4110,9 @@ gtk_icon_view_get_path_at_pos (GtkIconView *icon_view,
* @icon_view: A #GtkIconView.
* @x: The x position to be identified
* @y: The y position to be identified
* @path: (out) (optional): Return location for the path, or %NULL
* @path: (out) (optional): Return location for the path
* @cell: (out) (optional) (transfer none): Return location for the renderer
* responsible for the cell at (@x, @y), or %NULL
* responsible for the cell at (@x, @y)
*
* Gets the path and cell for the icon at the given position.
*
@ -4150,7 +4150,7 @@ gtk_icon_view_get_item_at_pos (GtkIconView *icon_view,
* gtk_icon_view_get_cell_rect:
* @icon_view: a #GtkIconView
* @path: a #GtkTreePath
* @cell: (nullable): a #GtkCellRenderer or %NULL
* @cell: (nullable): a #GtkCellRenderer
* @rect: (out): rectangle to fill with cell rect
*
* Fills the bounding rectangle in widget coordinates for the cell specified by
@ -4225,7 +4225,7 @@ gtk_icon_view_set_tooltip_item (GtkIconView *icon_view,
* @icon_view: a #GtkIconView
* @tooltip: a #GtkTooltip
* @path: a #GtkTreePath
* @cell: (nullable): a #GtkCellRenderer or %NULL
* @cell: (nullable): a #GtkCellRenderer
*
* Sets the tip area of @tooltip to the area which @cell occupies in
* the item pointed to by @path. See also gtk_tooltip_set_tip_area().
@ -6368,7 +6368,7 @@ gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view)
/**
* gtk_icon_view_set_drag_dest_item:
* @icon_view: a #GtkIconView
* @path: (nullable): The path of the item to highlight, or %NULL.
* @path: (nullable): The path of the item to highlight
* @pos: Specifies where to drop, relative to the item
*
* Sets the item that is highlighted for feedback.
@ -6455,9 +6455,8 @@ gtk_icon_view_get_drag_dest_item (GtkIconView *icon_view,
* @icon_view: a #GtkIconView
* @drag_x: the position to determine the destination item for
* @drag_y: the position to determine the destination item for
* @path: (out) (optional): Return location for the path of the item,
* or %NULL.
* @pos: (out) (optional): Return location for the drop position, or %NULL
* @path: (out) (optional): Return location for the path of the item
* @pos: (out) (optional): Return location for the drop position
*
* Determines the destination item for a given position.
*

21
gtk/gtkimage.c
View File

@ -477,7 +477,7 @@ gtk_image_new_from_resource (const char *resource_path)
/**
* gtk_image_new_from_pixbuf:
* @pixbuf: (nullable): a `GdkPixbuf`, or %NULL
* @pixbuf: (nullable): a `GdkPixbuf`
*
* Creates a new `GtkImage` displaying @pixbuf.
*
@ -508,7 +508,7 @@ gtk_image_new_from_pixbuf (GdkPixbuf *pixbuf)
/**
* gtk_image_new_from_paintable:
* @paintable: (nullable): a `GdkPaintable`, or %NULL
* @paintable: (nullable): a `GdkPaintable`
*
* Creates a new `GtkImage` displaying @paintable.
*
@ -535,7 +535,7 @@ gtk_image_new_from_paintable (GdkPaintable *paintable)
/**
* gtk_image_new_from_icon_name:
* @icon_name: (nullable): an icon name or %NULL
* @icon_name: (nullable): an icon name
*
* Creates a `GtkImage` displaying an icon from the current icon theme.
*
@ -584,7 +584,7 @@ gtk_image_new_from_gicon (GIcon *icon)
/**
* gtk_image_set_from_file: (attributes org.gtk.Method.set_property=file)
* @image: a `GtkImage`
* @filename: (type filename) (nullable): a filename or %NULL
* @filename: (type filename) (nullable): a filename
*
* Sets a `GtkImage` to show a file.
*
@ -662,7 +662,7 @@ out:
/**
* gtk_image_set_from_resource: (attributes org.gtk.Method.set_property=resource)
* @image: a `GtkImage`
* @resource_path: (nullable): a resource path or %NULL
* @resource_path: (nullable): a resource path
*
* Sets a `GtkImage` to show a resource.
*
@ -753,7 +753,7 @@ gtk_image_set_from_pixbuf (GtkImage *image,
/**
* gtk_image_set_from_icon_name: (attributes org.gtk.Method.set_property=icon-name)
* @image: a `GtkImage`
* @icon_name: (nullable): an icon name or %NULL
* @icon_name: (nullable): an icon name
*
* Sets a `GtkImage` to show a named icon.
*
@ -827,7 +827,7 @@ gtk_image_paintable_invalidate_size (GdkPaintable *paintable,
/**
* gtk_image_set_from_paintable: (attributes org.gtk.Method.set_property=paintable)
* @image: a `GtkImage`
* @paintable: (nullable): a `GdkPaintable` or %NULL
* @paintable: (nullable): a `GdkPaintable`
*
* Sets a `GtkImage` to show a `GdkPaintable`.
*
@ -903,8 +903,7 @@ gtk_image_get_storage_type (GtkImage *image)
* The caller of this function does not own a reference to the
* returned paintable.
*
* Returns: (nullable) (transfer none): the displayed paintable,
* or %NULL if the image is empty
* Returns: (nullable) (transfer none): the displayed paintable
*/
GdkPaintable *
gtk_image_get_paintable (GtkImage *image)
@ -925,7 +924,7 @@ gtk_image_get_paintable (GtkImage *image)
* The returned string is owned by the `GtkImage` and should not
* be freed.
*
* Returns: (transfer none) (nullable): the icon name, or %NULL
* Returns: (transfer none) (nullable): the icon name
*/
const char *
gtk_image_get_icon_name (GtkImage *image)
@ -946,7 +945,7 @@ gtk_image_get_icon_name (GtkImage *image)
* The caller of this function does not own a reference to the
* returned `GIcon`.
*
* Returns: (transfer none) (nullable): a `GIcon`, or %NULL
* Returns: (transfer none) (nullable): a `GIcon`
**/
GIcon *
gtk_image_get_gicon (GtkImage *image)

2
gtk/gtkinfobar.c
View File

@ -702,7 +702,7 @@ gtk_info_bar_new (void)
/**
* gtk_info_bar_new_with_buttons:
* @first_button_text: (nullable): ext to go in first button, or %NULL
* @first_button_text: (nullable): ext to go in first button
* @...: response ID for first button, then additional buttons, ending
* with %NULL
*

12
gtk/gtklabel.c
View File

@ -3043,7 +3043,7 @@ gtk_label_set_text (GtkLabel *self,
/**
* gtk_label_set_attributes: (attributes org.gtk.Method.set_property=attributes)
* @self: a `GtkLabel`
* @attrs: (nullable): a [struct@Pango.AttrList], or %NULL
* @attrs: (nullable): a [struct@Pango.AttrList]
*
* Apply attributes to the label text.
*
@ -3089,8 +3089,7 @@ gtk_label_set_attributes (GtkLabel *self,
* attributes for the label, use
* `pango_layout_get_attribute (gtk_label_get_layout (self))`.
*
* Returns: (nullable) (transfer none): the attribute list, or %NULL
* if none was set.
* Returns: (nullable) (transfer none): the attribute list
*/
PangoAttrList *
gtk_label_get_attributes (GtkLabel *self)
@ -5011,8 +5010,8 @@ gtk_label_get_layout (GtkLabel *self)
/**
* gtk_label_get_layout_offsets:
* @self: a `GtkLabel`
* @x: (out) (optional): location to store X offset of layout, or %NULL
* @y: (out) (optional): location to store Y offset of layout, or %NULL
* @x: (out) (optional): location to store X offset of layout
* @y: (out) (optional): location to store Y offset of layout
*
* Obtains the coordinates where the label will draw its `PangoLayout`.
*
@ -5549,8 +5548,7 @@ gtk_label_do_popup (GtkLabel *self,
* This function is intended for use in a [signal@Gtk.Label::activate-link]
* handler or for use in a [signal@Gtk.Widget::query-tooltip] handler.
*
* Returns: (nullable): the currently active URI or %NULL if there is none.
* The string is owned by GTK and must not be freed or modified.
* Returns: (nullable): the currently active URI
*/
const char *
gtk_label_get_current_uri (GtkLabel *self)

17
gtk/gtklistbox.c
View File

@ -760,7 +760,7 @@ gtk_list_box_init (GtkListBox *box)
* case you should use [method@Gtk.ListBox.selected_foreach] to
* find all selected rows.
*
* Returns: (transfer none) (nullable): the selected row or %NULL
* Returns: (transfer none) (nullable): the selected row
*/
GtkListBoxRow *
gtk_list_box_get_selected_row (GtkListBox *box)
@ -780,7 +780,7 @@ gtk_list_box_get_selected_row (GtkListBox *box)
* If @index_ is negative or larger than the number of items in the
* list, %NULL is returned.
*
* Returns: (transfer none) (nullable): the child `GtkWidget` or %NULL
* Returns: (transfer none) (nullable): the child `GtkWidget`
*/
GtkListBoxRow *
gtk_list_box_get_row_at_index (GtkListBox *box,
@ -821,8 +821,7 @@ row_y_cmp_func (gconstpointer a,
*
* Gets the row at the @y position.
*
* Returns: (transfer none) (nullable): the row or %NULL
* in case no row exists for the given y coordinate.
* Returns: (transfer none) (nullable): the row
*/
GtkListBoxRow *
gtk_list_box_get_row_at_y (GtkListBox *box,
@ -846,7 +845,7 @@ gtk_list_box_get_row_at_y (GtkListBox *box,
/**
* gtk_list_box_select_row:
* @box: a `GtkListBox`
* @row: (nullable): The row to select or %NULL
* @row: (nullable): The row to select
*
* Make @row the currently selected row.
*/
@ -1014,7 +1013,7 @@ gtk_list_box_get_selected_rows (GtkListBox *box)
/**
* gtk_list_box_set_placeholder:
* @box: a `GtkListBox`
* @placeholder: (nullable): a #GtkWidget or %NULL
* @placeholder: (nullable): a #GtkWidget
*
* Sets the placeholder widget that is shown in the list when
* it doesn't display any visible children.
@ -1045,7 +1044,7 @@ gtk_list_box_set_placeholder (GtkListBox *box,
/**
* gtk_list_box_set_adjustment:
* @box: a `GtkListBox`
* @adjustment: (nullable): the adjustment, or %NULL
* @adjustment: (nullable): the adjustment
*
* Sets the adjustment (if any) that the widget uses to
* for vertical scrolling.
@ -3154,7 +3153,7 @@ gtk_list_box_row_changed (GtkListBoxRow *row)
* there is a header set already, and if so to update
* the state of it.
*
* Returns: (transfer none) (nullable): the current header, or %NULL if none
* Returns: (transfer none) (nullable): the current header
*/
GtkWidget *
gtk_list_box_row_get_header (GtkListBoxRow *row)
@ -3167,7 +3166,7 @@ gtk_list_box_row_get_header (GtkListBoxRow *row)
/**
* gtk_list_box_row_set_header:
* @row: a `GtkListBoxRow`
* @header: (nullable): the header, or %NULL
* @header: (nullable): the header
*
* Sets the current header of the @row.
*

8
gtk/gtkliststore.c
View File

@ -1284,7 +1284,7 @@ gtk_list_store_insert (GtkListStore *list_store,
* gtk_list_store_insert_before:
* @list_store: A #GtkListStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @sibling: (nullable): A valid #GtkTreeIter, or %NULL
* @sibling: (nullable): A valid #GtkTreeIter
*
* Inserts a new row before @sibling. If @sibling is %NULL, then the row will
* be appended to the end of the list. @iter will be changed to point to this
@ -1320,7 +1320,7 @@ gtk_list_store_insert_before (GtkListStore *list_store,
* gtk_list_store_insert_after:
* @list_store: A #GtkListStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
* @sibling: (nullable): A valid #GtkTreeIter, or %NULL
* @sibling: (nullable): A valid #GtkTreeIter
*
* Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
* prepended to the beginning of the list. @iter will be changed to point to
@ -1840,7 +1840,7 @@ gtk_list_store_move_to (GtkListStore *store,
* gtk_list_store_move_before:
* @store: A #GtkListStore.
* @iter: A #GtkTreeIter.
* @position: (nullable): A #GtkTreeIter, or %NULL.
* @position: (nullable): A #GtkTreeIter
*
* Moves @iter in @store to the position before @position. Note that this
* function only works with unsorted stores. If @position is %NULL, @iter
@ -1871,7 +1871,7 @@ gtk_list_store_move_before (GtkListStore *store,
* gtk_list_store_move_after:
* @store: A #GtkListStore.
* @iter: A #GtkTreeIter.
* @position: (nullable): A #GtkTreeIter or %NULL.
* @position: (nullable): A #GtkTreeIter
*
* Moves @iter in @store to the position after @position. Note that this
* function only works with unsorted stores. If @position is %NULL, @iter

8
gtk/gtklistview.c
View File

@ -926,8 +926,8 @@ gtk_list_view_init (GtkListView *self)
/**
* gtk_list_view_new:
* @model: (nullable) (transfer full): the model to use, or %NULL
* @factory: (nullable) (transfer full): The factory to populate items with, or %NULL
* @model: (nullable) (transfer full): the model to use
* @factory: (nullable) (transfer full): The factory to populate items with
*
* Creates a new `GtkListView` that uses the given @factory for
* mapping items to widgets.
@ -981,7 +981,7 @@ gtk_list_view_get_model (GtkListView *self)
/**
* gtk_list_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkListView`
* @model: (nullable) (transfer none): the model to use or %NULL for none
* @model: (nullable) (transfer none): the model to use
*
* Sets the model to use.
*
@ -1023,7 +1023,7 @@ gtk_list_view_get_factory (GtkListView *self)
/**
* gtk_list_view_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkListView`
* @factory: (nullable) (transfer none): the factory to use or %NULL for none
* @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items.
*/

2
gtk/gtklockbutton.c
View File

@ -548,7 +548,7 @@ gtk_lock_button_get_permission (GtkLockButton *button)
/**
* gtk_lock_button_set_permission: (attributes org.gtk.Method.set_property=permission)
* @button: a `GtkLockButton`
* @permission: (nullable): a `GPermission` object, or %NULL
* @permission: (nullable): a `GPermission` object
*
* Sets the `GPermission` object that controls @button.
*/

2
gtk/gtkmain.c
View File

@ -1789,7 +1789,7 @@ gtk_get_current_event_time (void)
* originally.
*
* Returns: (transfer none) (nullable): the widget that originally
* received @event, or %NULL
* received @event
*/
GtkWidget *
gtk_get_event_widget (GdkEvent *event)

6
gtk/gtkmaplistmodel.c
View File

@ -410,8 +410,8 @@ gtk_map_list_model_augment (GtkRbTree *map,
/**
* gtk_map_list_model_new:
* @model: (transfer full) (nullable): The model to map or %NULL for none
* @map_func: (nullable): map function or %NULL to not map items
* @model: (transfer full) (nullable): The model to map
* @map_func: (nullable): map function
* @user_data: (closure): user data passed to @map_func
* @user_destroy: destroy notifier for @user_data
*
@ -488,7 +488,7 @@ gtk_map_list_model_init_items (GtkMapListModel *self)
/**
* gtk_map_list_model_set_map_func:
* @self: a `GtkMapListModel`
* @map_func: (nullable): map function or %NULL to not map items
* @map_func: (nullable): map function
* @user_data: (closure): user data passed to @map_func
* @user_destroy: destroy notifier for @user_data
*

2
gtk/gtkmediacontrols.c
View File

@ -480,7 +480,7 @@ gtk_media_controls_notify_cb (GtkMediaStream *stream,
/**
* gtk_media_controls_set_media_stream: (attributes org.gtk.Method.set_property=media-stream)
* @controls: a `GtkMediaControls` widget
* @stream: (nullable): a `GtkMediaStream`, or %NULL
* @stream: (nullable): a `GtkMediaStream`
*
* Sets the stream that is controlled by @controls.
*/

4
gtk/gtkmediafile.c
View File

@ -534,7 +534,6 @@ gtk_media_file_set_file (GtkMediaFile *self,
* %NULL is returned.
*
* Returns: (nullable) (transfer none): The currently playing file
* or %NULL if not playing from a file.
*/
GFile *
gtk_media_file_get_file (GtkMediaFile *self)
@ -594,8 +593,7 @@ gtk_media_file_set_input_stream (GtkMediaFile *self,
* When @self is not playing or not playing from a stream,
* %NULL is returned.
*
* Returns: (nullable) (transfer none): The currently playing
* stream or %NULL if not playing from a stream.
* Returns: (nullable) (transfer none): The currently playing stream
*/
GInputStream *
gtk_media_file_get_input_stream (GtkMediaFile *self)

2
gtk/gtkmenubutton.c
View File

@ -600,7 +600,7 @@ gtk_menu_button_set_menu_model (GtkMenuButton *menu_button,
*
* Returns the `GMenuModel` used to generate the popup.
*
* Returns: (nullable) (transfer none): a `GMenuModel` or %NULL
* Returns: (nullable) (transfer none): a `GMenuModel`
*/
GMenuModel *
gtk_menu_button_get_menu_model (GtkMenuButton *menu_button)

10
gtk/gtkmessagedialog.c
View File

@ -478,11 +478,11 @@ gtk_message_dialog_init (GtkMessageDialog *dialog)
/**
* gtk_message_dialog_new:
* @parent: (nullable): transient parent, or %NULL for none
* @parent: (nullable): transient parent
* @flags: flags
* @type: type of message
* @buttons: set of buttons to use
* @message_format: (nullable): printf()-style format string, or %NULL
* @message_format: (nullable): printf()-style format string
* @...: arguments for @message_format
*
* Creates a new message dialog.
@ -542,11 +542,11 @@ gtk_message_dialog_new (GtkWindow *parent,
/**
* gtk_message_dialog_new_with_markup:
* @parent: (nullable): transient parent, or %NULL for none
* @parent: (nullable): transient parent
* @flags: flags
* @type: type of message
* @buttons: set of buttons to use
* @message_format: (nullable): printf()-style format string, or %NULL
* @message_format: (nullable): printf()-style format string
* @...: arguments for @message_format
*
* Creates a new message dialog.
@ -632,7 +632,7 @@ gtk_message_dialog_set_markup (GtkMessageDialog *message_dialog,
/**
* gtk_message_dialog_format_secondary_text:
* @message_dialog: a `GtkMessageDialog`
* @message_format: (nullable): printf()-style format string, or %NULL
* @message_format: (nullable): printf()-style format string
* @...: arguments for @message_format
*
* Sets the secondary text of the message dialog.

4
gtk/gtkmountoperation.c
View File

@ -1790,7 +1790,7 @@ gtk_mount_operation_aborted (GMountOperation *op)
/**
* gtk_mount_operation_new:
* @parent: (nullable): transient parent of the window, or %NULL
* @parent: (nullable): transient parent of the window
*
* Creates a new `GtkMountOperation`.
*
@ -1827,7 +1827,7 @@ gtk_mount_operation_is_showing (GtkMountOperation *op)
/**
* gtk_mount_operation_set_parent: (attributes org.gtk.Method.set_property=parent)
* @op: a `GtkMountOperation`
* @parent: (nullable): transient parent of the window, or %NULL
* @parent: (nullable): transient parent of the window
*
* Sets the transient parent for windows shown by the
* `GtkMountOperation`.

2
gtk/gtkmultiselection.c
View File

@ -367,7 +367,7 @@ gtk_multi_selection_init (GtkMultiSelection *self)
/**
* gtk_multi_selection_new:
* @model: (nullable) (transfer full): the `GListModel` to manage, or %NULL
* @model: (nullable) (transfer full): the `GListModel` to manage
*
* Creates a new selection to handle @model.
*

2
gtk/gtknativedialog.c
View File

@ -501,7 +501,7 @@ parent_destroyed (GtkWidget *parent,
/**
* gtk_native_dialog_set_transient_for: (attributes org.gtk.Method.set_property=transient-for)
* @self: a `GtkNativeDialog`
* @parent: (nullable): parent window, or %NULL
* @parent: (nullable): parent window
*
* Dialog windows should be set transient for the main application
* window they were spawned from.

2
gtk/gtknoselection.c
View File

@ -213,7 +213,7 @@ gtk_no_selection_init (GtkNoSelection *self)
/**
* gtk_no_selection_new:
* @model: (nullable) (transfer full): the `GListModel` to manage, or %NULL
* @model: (nullable) (transfer full): the `GListModel` to manage
*
* Creates a new selection to handle @model.
*

4
gtk/gtknotebook.c
View File

@ -1376,8 +1376,8 @@ gtk_notebook_class_init (GtkNotebookClass *class)
* necessary properties to the notebook (e.g. the
* `GtkNotebook`:group-name ).
*
* Returns: (transfer none): a `GtkNotebook` that @page should be
* added to, or %NULL.
* Returns: (nullable) (transfer none): a `GtkNotebook` that
* @page should be added to
*/
notebook_signals[CREATE_WINDOW] =
g_signal_new (I_("create-window"),

4
gtk/gtknumericsorter.c
View File

@ -607,7 +607,7 @@ gtk_numeric_sorter_new (GtkExpression *expression)
*
* Gets the expression that is evaluated to obtain numbers from items.
*
* Returns: (transfer none) (nullable): a `GtkExpression`, or %NULL
* Returns: (transfer none) (nullable): a `GtkExpression`
*/
GtkExpression *
gtk_numeric_sorter_get_expression (GtkNumericSorter *self)
@ -620,7 +620,7 @@ gtk_numeric_sorter_get_expression (GtkNumericSorter *self)
/**
* gtk_numeric_sorter_set_expression: (attributes org.gtk.Method.set_property=expression)
* @self: a `GtkNumericSorter`
* @expression: (nullable) (transfer none): a `GtkExpression`, or %NULL
* @expression: (nullable) (transfer none): a `GtkExpression`
*
* Sets the expression that is evaluated to obtain numbers from items.
*

14
gtk/gtkpagesetup.c
View File

@ -491,7 +491,7 @@ gtk_page_setup_get_page_height (GtkPageSetup *setup,
* gtk_page_setup_load_file:
* @setup: a `GtkPageSetup`
* @file_name: (type filename): the filename to read the page setup from
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Reads the page setup from the file @file_name.
*
@ -524,7 +524,7 @@ gtk_page_setup_load_file (GtkPageSetup *setup,
/**
* gtk_page_setup_new_from_file:
* @file_name: (type filename): the filename to read the page setup from
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Reads the page setup from the file @file_name.
*
@ -574,9 +574,9 @@ string_to_enum (GType type,
* gtk_page_setup_load_key_file:
* @setup: a `GtkPageSetup`
* @key_file: the `GKeyFile` to retrieve the page_setup from
* @group_name: (nullable): the name of the group in the key_file to read, or %NULL
* @group_name: (nullable): the name of the group in the key_file to read
* to use the default name “Page Setup”
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Reads the page setup from the group @group_name in the key file
* @key_file.
@ -660,9 +660,9 @@ out:
/**
* gtk_page_setup_new_from_key_file:
* @key_file: the `GKeyFile` to retrieve the page_setup from
* @group_name: (nullable): the name of the group in the key_file to read, or %NULL
* @group_name: (nullable): the name of the group in the key_file to read
* to use the default name “Page Setup”
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Reads the page setup from the group @group_name in the key file
* @key_file.
@ -692,7 +692,7 @@ gtk_page_setup_new_from_key_file (GKeyFile *key_file,
* gtk_page_setup_to_file:
* @setup: a `GtkPageSetup`
* @file_name: (type filename): the file to save to
* @error: (nullable): return location for errors, or %NULL
* @error: (nullable): return location for errors
*
* This function saves the information from @setup to @file_name.
*

4
gtk/gtkpagesetupunixdialog.c
View File

@ -767,8 +767,8 @@ paper_size_changed (GtkDropDown *combo_box,
/**
* gtk_page_setup_unix_dialog_new:
* @title: (nullable): the title of the dialog, or %NULL
* @parent: (nullable): transient parent of the dialog, or %NULL
* @title: (nullable): the title of the dialog
* @parent: (nullable): transient parent of the dialog
*
* Creates a new page setup dialog.
*

4
gtk/gtkpango.c
View File

@ -38,8 +38,8 @@ attr_list_merge_filter (PangoAttribute *attribute,
/*
* _gtk_pango_attr_list_merge:
* @into: a #PangoAttrList where attributes are merged or %NULL
* @from: a #PangoAttrList with the attributes to merge or %NULL
* @into: (nullable): a #PangoAttrList where attributes are merged
* @from: (nullable): a #PangoAttrList with the attributes to merge
*
* Merges attributes from @from into @into.
*

7
gtk/gtkpapersize.c
View File

@ -205,7 +205,7 @@ gtk_paper_size_new_from_info (const PaperInfo *info)
/**
* gtk_paper_size_new:
* @name: (nullable): a paper size name, or %NULL
* @name: (nullable): a paper size name
*
* Creates a new `GtkPaperSize` object by parsing a
* [PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf)
@ -910,13 +910,12 @@ gtk_paper_size_get_default_right_margin (GtkPaperSize *size,
* @key_file: the `GKeyFile` to retrieve the papersize from
* @group_name: (nullable): the name of the group in the key file to read,
* or %NULL to read the first group
* @error: (nullable): return location for an error, or %NULL
* @error: (nullable): return location for an error
*
* Reads a paper size from the group @group_name in the key file
* @key_file.
*
* Returns: a new `GtkPaperSize` object with the restored
* paper size, or %NULL if an error occurred
* Returns: a new `GtkPaperSize` object with the restored paper size
*/
GtkPaperSize *
gtk_paper_size_new_from_key_file (GKeyFile *key_file,

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