Merge branch 'bilelmoussaoui/g-i' into 'main'

gdk: add missing nullable annotations

See merge request GNOME/gtk!4310

24 files changed, 35 insertions, 35 deletions

diff --git a/gdk/gdkcontentdeserializer.c b/gdk/gdkcontentdeserializer.c
index 081380f447..a9a1d08a9c 100644
--- a/gdk/gdkcontentdeserializer.c
+++ b/gdk/gdkcontentdeserializer.c
@@ -264,7 +264,7 @@ gdk_content_deserializer_get_priority (GdkContentDeserializer *deserializer)
  *
  * This is the `GCancellable` that was passed to [func@Gdk.content_deserialize_async].
  *
- * Returns: (transfer none): the cancellable for the current operation
+ * Returns: (transfer none) (nullable): the cancellable for the current operation
  */
 GCancellable *
 gdk_content_deserializer_get_cancellable (GdkContentDeserializer *deserializer)
diff --git a/gdk/gdkcontentserializer.c b/gdk/gdkcontentserializer.c
index 75734e2765..3d1295b33e 100644
--- a/gdk/gdkcontentserializer.c
+++ b/gdk/gdkcontentserializer.c
@@ -270,7 +270,7 @@ gdk_content_serializer_get_priority (GdkContentSerializer *serializer)
  *
  * This is the `GCancellable` that was passed to [func@content_serialize_async].
  *
- * Returns: (transfer none): the cancellable for the current operation
+ * Returns: (transfer none) (nullable): the cancellable for the current operation
  */
 GCancellable *
 gdk_content_serializer_get_cancellable (GdkContentSerializer *serializer)
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index e577c6b9c0..1f4a920720 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -1225,7 +1225,7 @@ gdk_event_get_event_type (GdkEvent *event)
  *
  * Extracts the surface associated with an event.
  *
- * Returns: (transfer none): The `GdkSurface` associated with the event
+ * Returns: (transfer none) (nullable): The `GdkSurface` associated with the event
  */
 GdkSurface *
 gdk_event_get_surface (GdkEvent *event)
diff --git a/gdk/gdkpopup.c b/gdk/gdkpopup.c
index a71e63d57e..4dd97ac7ad 100644
--- a/gdk/gdkpopup.c
+++ b/gdk/gdkpopup.c
@@ -187,7 +187,7 @@ gdk_popup_get_rect_anchor (GdkPopup *popup)
  *
  * Returns the parent surface of a popup.
  *
- * Returns: (transfer none): the parent surface
+ * Returns: (transfer none) (nullable): the parent surface
  */
 GdkSurface *
 gdk_popup_get_parent (GdkPopup *popup)
diff --git a/gdk/x11/gdksurface-x11.c b/gdk/x11/gdksurface-x11.c
index 4e2c2e9e11..8567d83eb8 100644
--- a/gdk/x11/gdksurface-x11.c
+++ b/gdk/x11/gdksurface-x11.c
@@ -3535,7 +3535,7 @@ gdk_x11_surface_unfullscreen (GdkSurface *surface)
  *
  * Returns the group this surface belongs to.
  *
- * Returns: (transfer none): The group of this surface;
+ * Returns: (transfer none) (nullable): The group of this surface;
  */
 GdkSurface *
 gdk_x11_surface_get_group (GdkSurface *surface)
diff --git a/gtk/css/gtkcsssection.c b/gtk/css/gtkcsssection.c
index 5851cc201c..727141fdb6 100644
--- a/gtk/css/gtkcsssection.c
+++ b/gtk/css/gtkcsssection.c
@@ -140,7 +140,7 @@ gtk_css_section_get_parent (const GtkCssSection *section)
  * If no such file exists, for example because the CSS was loaded via
  * [method@Gtk.CssProvider.load_from_data], then `NULL` is returned.
  *
- * Returns: (transfer none): the `GFile` from which the `section`
+ * Returns: (transfer none) (nullable): the `GFile` from which the `section`
  *   was parsed
  **/
 GFile *
diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c
index 1eb45c0308..bcd88171ad 100644
--- a/gtk/gtkbuildable.c
+++ b/gtk/gtkbuildable.c
@@ -83,7 +83,7 @@ gtk_buildable_set_buildable_id (GtkBuildable *buildable,
  * `GtkBuilder` sets the name based on the ID attribute
  * of the <object> tag used to construct the @buildable.
  *
- * Returns: the ID of the buildable object
+ * Returns: (nullable): the ID of the buildable object
  **/
 const char *
 gtk_buildable_get_buildable_id (GtkBuildable *buildable)
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
index c472e115db..78cfdb1001 100644
--- a/gtk/gtkfilechooser.c
+++ b/gtk/gtkfilechooser.c
@@ -523,7 +523,7 @@ gtk_file_chooser_set_file (GtkFileChooser  *chooser,
  * If the file chooser is in folder mode, this function returns
  * the selected folder.
  *
- * Returns: (transfer full): a selected `GFile`. You own the
+ * Returns: (transfer full) (nullable): a selected `GFile`. You own the
  *   returned file; use g_object_unref() to release it.
  */
 GFile *
@@ -794,7 +794,7 @@ gtk_file_chooser_set_choice (GtkFileChooser  *chooser,
  *
  * Gets the currently selected option in the 'choice' with the given ID.
  *
- * Returns: the ID of the currently selected option
+ * Returns: (nullable): the ID of the currently selected option
  */
 const char *
 gtk_file_chooser_get_choice (GtkFileChooser  *chooser,
diff --git a/gtk/gtkflattenlistmodel.c b/gtk/gtkflattenlistmodel.c
index 23b26a35f4..15a164f5c9 100644
--- a/gtk/gtkflattenlistmodel.c
+++ b/gtk/gtkflattenlistmodel.c
@@ -510,7 +510,7 @@ gtk_flatten_list_model_get_model (GtkFlattenListModel *self)
  *
  * Returns the model containing the item at the given position.
  *
- * Returns: (transfer none): the model containing the item at @position
+ * Returns: (transfer none) (nullable): the model containing the item at @position
  */
 GListModel *
 gtk_flatten_list_model_get_model_for_item (GtkFlattenListModel *self,
diff --git a/gtk/gtkglarea.c b/gtk/gtkglarea.c
index 655c102cd7..de7cc7fa0f 100644
--- a/gtk/gtkglarea.c
+++ b/gtk/gtkglarea.c
@@ -1317,7 +1317,7 @@ gtk_gl_area_set_auto_render (GtkGLArea *area,
  *
  * Retrieves the `GdkGLContext` used by @area.
  *
- * Returns: (transfer none): the `GdkGLContext`
+ * Returns: (transfer none) (nullable): the `GdkGLContext`
  */
 GdkGLContext *
 gtk_gl_area_get_context (GtkGLArea *area)
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index 55829feac4..a01879afa8 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -6519,7 +6519,7 @@ gtk_icon_view_get_dest_item_at_pos (GtkIconView              *icon_view,
  * Creates a `GdkPaintable` representation of the item at @path.
  * This image is used for a drag icon.
  *
- * Returns: (transfer full): a newly-allocated `GdkPaintable` of the drag icon.
+ * Returns: (transfer full) (nullable): a newly-allocated `GdkPaintable` of the drag icon.
  **/
 GdkPaintable *
 gtk_icon_view_create_drag_icon (GtkIconView *icon_view,
diff --git a/gtk/gtklistbox.c b/gtk/gtklistbox.c
index 95120f8cef..3a75bc0f3e 100644
--- a/gtk/gtklistbox.c
+++ b/gtk/gtklistbox.c
@@ -1078,7 +1078,7 @@ gtk_list_box_set_adjustment (GtkListBox    *box,
  * Gets the adjustment (if any) that the widget uses to
  * for vertical scrolling.
  *
- * Returns: (transfer none): the adjustment
+ * Returns: (transfer none) (nullable): the adjustment
  */
 GtkAdjustment *
 gtk_list_box_get_adjustment (GtkListBox *box)
diff --git a/gtk/gtklockbutton.c b/gtk/gtklockbutton.c
index 5862e866d8..dda8cc9147 100644
--- a/gtk/gtklockbutton.c
+++ b/gtk/gtklockbutton.c
@@ -535,7 +535,7 @@ gtk_lock_button_new (GPermission *permission)
  *
  * Obtains the `GPermission` object that controls @button.
  *
- * Returns: (transfer none): the `GPermission` of @button
+ * Returns: (transfer none) (nullable): the `GPermission` of @button
  */
 GPermission *
 gtk_lock_button_get_permission (GtkLockButton *button)
diff --git a/gtk/gtkmenubutton.c b/gtk/gtkmenubutton.c
index 370956da85..67c3236508 100644
--- a/gtk/gtkmenubutton.c
+++ b/gtk/gtkmenubutton.c
@@ -1059,7 +1059,7 @@ gtk_menu_button_set_icon_name (GtkMenuButton *menu_button,
  *
  * Gets the name of the icon shown in the button.
  *
- * Returns: the name of the icon shown in the button
+ * Returns: (nullable): the name of the icon shown in the button
  */
 const char *
 gtk_menu_button_get_icon_name (GtkMenuButton *menu_button)
@@ -1182,7 +1182,7 @@ gtk_menu_button_set_label (GtkMenuButton *menu_button,
  *
  * Gets the label shown in the button
  *
- * Returns: the label shown in the button
+ * Returns: (nullable): the label shown in the button
  */
 const char *
 gtk_menu_button_get_label (GtkMenuButton *menu_button)
diff --git a/gtk/gtkmountoperation.c b/gtk/gtkmountoperation.c
index baa4f785e5..43760283b4 100644
--- a/gtk/gtkmountoperation.c
+++ b/gtk/gtkmountoperation.c
@@ -1873,7 +1873,7 @@ gtk_mount_operation_set_parent (GtkMountOperation *op,
  *
  * Gets the transient parent used by the `GtkMountOperation`.
  *
- * Returns: (transfer none): the transient parent for windows shown by @op
+ * Returns: (transfer none) (nullable): the transient parent for windows shown by @op
  */
 GtkWindow *
 gtk_mount_operation_get_parent (GtkMountOperation *op)
diff --git a/gtk/gtkmultiselection.c b/gtk/gtkmultiselection.c
index 26590ec55f..bee83622c6 100644
--- a/gtk/gtkmultiselection.c
+++ b/gtk/gtkmultiselection.c
@@ -396,7 +396,7 @@ gtk_multi_selection_new (GListModel *model)
  *
  * Returns the underlying model of @self.
  *
- * Returns: (transfer none): the underlying model
+ * Returns: (transfer none) (nullable): the underlying model
  */
 GListModel *
 gtk_multi_selection_get_model (GtkMultiSelection *self)
diff --git a/gtk/gtknative.c b/gtk/gtknative.c
index 8a0b74a062..0154781379 100644
--- a/gtk/gtknative.c
+++ b/gtk/gtknative.c
@@ -267,7 +267,7 @@ gtk_native_get_surface_transform (GtkNative *self,
  *
  * Finds the `GtkNative` associated with the surface.
  *
- * Returns: (transfer none): the `GtkNative` that is associated with @surface
+ * Returns: (transfer none) (nullable): the `GtkNative` that is associated with @surface
  */
 GtkNative *
 gtk_native_get_for_surface (GdkSurface *surface)
diff --git a/gtk/gtknoselection.c b/gtk/gtknoselection.c
index 7727ccc00b..9b48082d6a 100644
--- a/gtk/gtknoselection.c
+++ b/gtk/gtknoselection.c
@@ -242,7 +242,7 @@ gtk_no_selection_new (GListModel *model)
  *
  * Gets the model that @self is wrapping.
  *
- * Returns: (transfer none): The model being wrapped
+ * Returns: (transfer none) (nullable): The model being wrapped
  */
 GListModel *
 gtk_no_selection_get_model (GtkNoSelection *self)
diff --git a/gtk/gtkpasswordentry.c b/gtk/gtkpasswordentry.c
index 7e375a05bc..b6a6dea51b 100644
--- a/gtk/gtkpasswordentry.c
+++ b/gtk/gtkpasswordentry.c
@@ -729,7 +729,7 @@ gtk_password_entry_set_extra_menu (GtkPasswordEntry *entry,
  *
  * Gets the menu model set with gtk_password_entry_set_extra_menu().
  *
- * Returns: (transfer none): (nullable): the menu model
+ * Returns: (transfer none) (nullable): the menu model
  */
 GMenuModel *
 gtk_password_entry_get_extra_menu (GtkPasswordEntry *entry)
diff --git a/gtk/gtkpopovermenu.c b/gtk/gtkpopovermenu.c
index 0c4f57ecf2..9daae2b8b8 100644
--- a/gtk/gtkpopovermenu.c
+++ b/gtk/gtkpopovermenu.c
@@ -819,7 +819,7 @@ gtk_popover_menu_set_menu_model (GtkPopoverMenu *popover,
  *
  * Returns the menu model used to populate the popover.
  *
- * Returns: (transfer none): the menu model of @popover
+ * Returns: (transfer none) (nullable): the menu model of @popover
  */
 GMenuModel *
 gtk_popover_menu_get_menu_model (GtkPopoverMenu *popover)
diff --git a/gtk/gtkpopovermenubar.c b/gtk/gtkpopovermenubar.c
index b2a3635e5a..a3fbd8fb09 100644
--- a/gtk/gtkpopovermenubar.c
+++ b/gtk/gtkpopovermenubar.c
@@ -746,7 +746,7 @@ gtk_popover_menu_bar_set_menu_model (GtkPopoverMenuBar *bar,
  *
  * Returns the model from which the contents of @bar are taken.
  *
- * Returns: (transfer none): a `GMenuModel`
+ * Returns: (transfer none) (nullable): a `GMenuModel`
  */
 GMenuModel *
 gtk_popover_menu_bar_get_menu_model (GtkPopoverMenuBar *bar)
diff --git a/gtk/gtkprintsettings.c b/gtk/gtkprintsettings.c
index ad6371b47f..7ca8bbb8c0 100644
--- a/gtk/gtkprintsettings.c
+++ b/gtk/gtkprintsettings.c
@@ -154,7 +154,7 @@ gtk_print_settings_copy (GtkPrintSettings *other)
  *
  * Looks up the string value associated with @key.
  *
- * Returns: the string value for @key
+ * Returns: (nullable): the string value for @key
  */
 const char *
 gtk_print_settings_get (GtkPrintSettings *settings,
@@ -480,7 +480,7 @@ gtk_print_settings_foreach (GtkPrintSettings    *settings,
  * Convenience function to obtain the value of
  * %GTK_PRINT_SETTINGS_PRINTER.
  *
- * Returns: the printer name
+ * Returns: (nullable): the printer name
  */
 const char *
 gtk_print_settings_get_printer (GtkPrintSettings *settings)
@@ -574,7 +574,7 @@ gtk_print_settings_set_orientation (GtkPrintSettings   *settings,
  * Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
  * converted to a `GtkPaperSize`.
  *
- * Returns: the paper size
+ * Returns: (nullable): the paper size
  */
 GtkPaperSize *     
 gtk_print_settings_get_paper_size (GtkPrintSettings *settings)
@@ -779,7 +779,7 @@ gtk_print_settings_set_collate (GtkPrintSettings *settings,
  *
  * Gets the value of %GTK_PRINT_SETTINGS_REVERSE.
  *
- * Returns: whether to reverse the order of the printed pages
+ * Returns:  whether to reverse the order of the printed pages
  */
 gboolean
 gtk_print_settings_get_reverse (GtkPrintSettings *settings)
@@ -1415,7 +1415,7 @@ gtk_print_settings_set_page_ranges  (GtkPrintSettings *settings,
  * 
  * Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
  * 
- * Returns: the default source
+ * Returns: (nullable): the default source
  */
 const char *
 gtk_print_settings_get_default_source (GtkPrintSettings *settings)
@@ -1445,7 +1445,7 @@ gtk_print_settings_set_default_source (GtkPrintSettings *settings,
  *
  * The set of media types is defined in PWG 5101.1-2002 PWG.
  * 
- * Returns: the media type
+ * Returns: (nullable): the media type
  */
 const char *
 gtk_print_settings_get_media_type (GtkPrintSettings *settings)
@@ -1475,7 +1475,7 @@ gtk_print_settings_set_media_type (GtkPrintSettings *settings,
  * 
  * Gets the value of %GTK_PRINT_SETTINGS_DITHER.
  * 
- * Returns: the dithering that is used
+ * Returns: (nullable): the dithering that is used
  */
 const char *
 gtk_print_settings_get_dither (GtkPrintSettings *settings)
@@ -1503,7 +1503,7 @@ gtk_print_settings_set_dither (GtkPrintSettings *settings,
  * 
  * Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
  * 
- * Returns: the finishings
+ * Returns: (nullable): the finishings
  */
 const char *
 gtk_print_settings_get_finishings (GtkPrintSettings *settings)
@@ -1531,7 +1531,7 @@ gtk_print_settings_set_finishings (GtkPrintSettings *settings,
  * 
  * Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
  * 
- * Returns: the output bin
+ * Returns: (nullable): the output bin
  */
 const char *
 gtk_print_settings_get_output_bin (GtkPrintSettings *settings)
diff --git a/gtk/gtkscrollable.c b/gtk/gtkscrollable.c
index 0d4a2d51af..041f09ac04 100644
--- a/gtk/gtkscrollable.c
+++ b/gtk/gtkscrollable.c
@@ -130,7 +130,7 @@ gtk_scrollable_default_init (GtkScrollableInterface *iface)
  *
  * Retrieves the `GtkAdjustment` used for horizontal scrolling.
  *
- * Returns: (transfer none): horizontal `GtkAdjustment`.
+ * Returns: (transfer none) (nullable): horizontal `GtkAdjustment`.
  */
 GtkAdjustment *
 gtk_scrollable_get_hadjustment (GtkScrollable *scrollable)
@@ -174,7 +174,7 @@ gtk_scrollable_set_hadjustment (GtkScrollable *scrollable,
  *
  * Retrieves the `GtkAdjustment` used for vertical scrolling.
  *
- * Returns: (transfer none): vertical `GtkAdjustment`.
+ * Returns: (transfer none) (nullable): vertical `GtkAdjustment`.
  */
 GtkAdjustment *
 gtk_scrollable_get_vadjustment (GtkScrollable *scrollable)
diff --git a/gtk/gtktextmark.c b/gtk/gtktextmark.c
index 878c6ed57f..58b56057c2 100644
--- a/gtk/gtktextmark.c
+++ b/gtk/gtktextmark.c
@@ -346,7 +346,7 @@ gtk_text_mark_get_deleted (GtkTextMark *mark)
  *
  * Returns %NULL if the mark is deleted.
  *
- * Returns: (transfer none): the mark’s `GtkTextBuffer`
+ * Returns: (transfer none) (nullable): the mark’s `GtkTextBuffer`
  */
 GtkTextBuffer*
 gtk_text_mark_get_buffer (GtkTextMark *mark)