From 7dfed55929a66dafcdf375ee0f0aba729b067ae9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Cerveau?= <scerveau@igalia.com>
Date: Wed, 13 Nov 2024 16:04:44 +0100
Subject: [PATCH] vkoperation: update doc to skip barriers array methods

Some methods are using arrays of element which type can
vary at compile time. These methods should not
be introspectable as it's not possible to determine
the final type.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7880>
---
 girs/GstVulkan-1.0.gir                             |  6 ++++--
 .../gst-libs/gst/vulkan/gstvkoperation.c           | 14 ++++++++------
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/girs/GstVulkan-1.0.gir b/girs/GstVulkan-1.0.gir
index 35ffb545e0..a889f79d69 100644
--- a/girs/GstVulkan-1.0.gir
+++ b/girs/GstVulkan-1.0.gir
@@ -4889,7 +4889,7 @@ Remember to call gst_vulkan_operation_update_frame() after adding the barrier
 related with that frame.</doc>
         <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.h"/>
         <return-value transfer-ownership="full">
-          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">A new allocated array of barriers, either
+          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">A new allocated #GArray of barriers, either
     VkImageMemoryBarrier or VkImageMemoryBarrier2KHR, depending whether
     synchronization2 extension is used.</doc>
           <array name="GLib.Array" c:type="GArray*">
@@ -4943,7 +4943,9 @@ The element type of the array might be, depending on if synchronization2
 extension is used, either VkImageMemoryBarrier or VkImageMemoryBarrier2KHR.</doc>
         <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.h"/>
         <return-value transfer-ownership="full">
-          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">Current barriers array. Call g_array_unref() after
+          <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c">Current barriers #GArray, either
+   VkImageMemoryBarrier or VkImageMemoryBarrier2KHR, depending whether
+   synchronization2 extension is used. Call g_array_unref() after
    the operation is using.</doc>
           <array name="GLib.Array" c:type="GArray*">
             <type name="gpointer" c:type="gpointer"/>
diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c
index 5a1373f435..a1edaba1c7 100644
--- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c
+++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkoperation.c
@@ -726,7 +726,7 @@ _get_image_barriers_unlocked (GstVulkanOperation * self)
 }
 
 /**
- * gst_vulkan_operation_retrieve_image_barriers:
+ * gst_vulkan_operation_retrieve_image_barriers: (skip)
  * @self: a #GstVulkanOperation
  *
  * Retrieves a copy of the current defined barriers internally, which will be
@@ -735,7 +735,9 @@ _get_image_barriers_unlocked (GstVulkanOperation * self)
  * The element type of the array might be, depending on if synchronization2
  * extension is used, either VkImageMemoryBarrier or VkImageMemoryBarrier2KHR.
  *
- * Returns: (transfer full): Current barriers array. Call g_array_unref() after
+ * Returns: (transfer full): Current barriers #GArray, either
+ *    VkImageMemoryBarrier or VkImageMemoryBarrier2KHR, depending whether
+ *    synchronization2 extension is used. Call g_array_unref() after
  *    the operation is using.
  */
 GArray *
@@ -751,7 +753,7 @@ gst_vulkan_operation_retrieve_image_barriers (GstVulkanOperation * self)
 }
 
 /**
- * gst_vulkan_operation_new_extra_image_barriers:
+ * gst_vulkan_operation_new_extra_image_barriers: (skip)
  * @self: a #GstVulkanOperation
  *
  * See also: gst_vulkan_operation_use_sync2(),
@@ -765,7 +767,7 @@ gst_vulkan_operation_retrieve_image_barriers (GstVulkanOperation * self)
  * Remember to call gst_vulkan_operation_update_frame() after adding the barrier
  * related with that frame.
  *
- * Returns: (transfer full): A new allocated array of barriers, either
+ * Returns: (transfer full): A new allocated #GArray of barriers, either
  *     VkImageMemoryBarrier or VkImageMemoryBarrier2KHR, depending whether
  *     synchronization2 extension is used.
  */
@@ -776,9 +778,9 @@ gst_vulkan_operation_new_extra_image_barriers (GstVulkanOperation * self)
 }
 
 /**
- * gst_vulkan_operation_add_extra_image_barriers:
+ * gst_vulkan_operation_add_extra_image_barriers: (skip)
  * @self: a #GstVulkanOperation
- * @extra_barriers: a #GArray of extra image memory barriers to handle, either
+ * @extra_barriers: (transfer none): a #GArray of extra image memory barriers to handle, either
  * VkImageMemoryBarrier or VkImageMemoryBarrier2KHR, depending whether
  * synchronization2 extension is used.
  *