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>
This commit is contained in:
Stéphane Cerveau 2024-11-13 16:04:44 +01:00 committed by GStreamer Marge Bot
parent 025b4a2f8d
commit 7dfed55929
2 changed files with 12 additions and 8 deletions

View file

@ -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"/>

View file

@ -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.
*