vulkan: Add missing `(nullable)` annotation to `Returns`

Most of these functions already state they might return `%NULL`, but
this is not picked up by G-IR.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1615>

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c
index 82756d7..423bb0d 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c
@@ -206,8 +206,8 @@ gst_vulkan_display_finalize (GObject * object)
  * @instance: a #GstVulkanInstance
  * @type: the #GstVulkanDisplayType to create
  *
- * Returns: (transfer full) (nullable): a new #GstVulkanDisplay or %NULL if e.g. @type is
- * unsupported
+ * Returns: (transfer full) (nullable): a new #GstVulkanDisplay or %NULL if
+ *                                      e.g. @type is unsupported
  *
  * Since: 1.18
  */
@@ -326,7 +326,8 @@ gst_vulkan_display_get_handle_type (GstVulkanDisplay * display)
  * gst_vulkan_display_create_window:
  * @display: a #GstVulkanDisplay
  *
- * Returns: (transfer full) (nullable): a new #GstVulkanWindow for @display or %NULL.
+ * Returns: (transfer full) (nullable): a new #GstVulkanWindow for @display or
+ *                                      %NULL.
  *
  * Since: 1.18
  */
@@ -400,8 +401,8 @@ window_weak_list_to_strong (GstVulkanDisplay * display)
  * first argument to @compare_func is the #GstVulkanWindow being checked and the
  * second argument is @data.
  *
- * Returns: (transfer full) (nullable): The first #GstVulkanWindow that causes a match
- *          from @compare_func
+ * Returns: (transfer full) (nullable): The first #GstVulkanWindow that
+ *                                      @compare_func matches, or %NULL
  *
  * Since: 1.18
  */
@@ -633,8 +634,8 @@ gst_vulkan_display_choose_type (GstVulkanInstance * instance)
  * gst_vulkan_display_type_to_extension_string:
  * @type: a #GstVulkanDisplayType
  *
- * Returns: (nullable): the Vulkan extension string required for creating a VkSurfaceKHR
- * using a window system handle or %NULL
+ * Returns: (nullable): the Vulkan extension string required for creating a
+ *                      VkSurfaceKHR using a window system handle or %NULL
  *
  * Since: 1.18
  */

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkfence.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkfence.c
index c2db919..1cd308b 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkfence.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkfence.c
@@ -89,7 +89,7 @@ gst_vulkan_fence_free (GstVulkanFence * fence)
  * @device: the parent #GstVulkanDevice
  * @error: (optional): a #GError for the failure condition
  *
- * Returns: whether a new #GstVulkanFence or %NULL on error
+ * Returns: a new #GstVulkanFence or %NULL on error
  *
  * Since: 1.18
  */

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkimagememory.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkimagememory.c
index 7a24249..90a8315 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkimagememory.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkimagememory.c
@@ -625,8 +625,8 @@ find_view_func (GstVulkanImageView * view, gpointer user_data)
  * @find_func: (scope call): #GstVulkanImageMemoryFindViewFunc to search with
  * @user_data: user data to call @finc_func with
  *
- * Return: (transfer full): the first #GstVulkanImageView that @find_func
- * returns %TRUE for, or %NULL
+ * Return: (transfer full) (nullable): the first #GstVulkanImageView that
+ *                                     @find_func returns %TRUE for, or %NULL
  *
  * Since: 1.18
  */

diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkqueue.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkqueue.c
index b462557..f457000 100644 (file)
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkqueue.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkqueue.c
@@ -114,7 +114,7 @@ gst_vulkan_queue_get_device (GstVulkanQueue * queue)
  * @queue: a #GstVulkanQueue
  * @error: (optional): a #GError
  *
- * Returns: (transfer full): a new #GstVUlkanCommandPool or %NULL
+ * Returns: (transfer full): a new #GstVulkanCommandPool or %NULL
  *
  * Since: 1.18
  */