From 2b91f7e165c87206fce80e0342768b13aeca3ef6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= <sebastian@centricular.com>
Date: Mon, 17 Oct 2022 11:31:05 +0300
Subject: [PATCH] allocators: Add/fix various annotations

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
---
 .../gst-plugins-base/gst-libs/gst/allocators/gstdmabuf.c | 9 ++++-----
 .../gst-libs/gst/allocators/gstfdmemory.c                | 7 +++----
 2 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstdmabuf.c b/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstdmabuf.c
index 3f4eaa9e48..2793b73c8f 100644
--- a/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstdmabuf.c
+++ b/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstdmabuf.c
@@ -121,9 +121,8 @@ gst_dmabuf_allocator_init (GstDmaBufAllocator * allocator)
  *
  * Return a new dmabuf allocator.
  *
- * Returns: (transfer full): a new dmabuf allocator, or NULL if the allocator
- *    isn't available. Use gst_object_unref() to release the allocator after
- *    usage
+ * Returns: (transfer full): a new dmabuf allocator. Use gst_object_unref() to
+ * release the allocator after usage
  *
  * Since: 1.2
  */
@@ -146,7 +145,7 @@ gst_dmabuf_allocator_new (void)
  *
  * Return a %GstMemory that wraps a dmabuf file descriptor.
  *
- * Returns: (transfer full): a GstMemory based on @allocator.
+ * Returns: (transfer full) (nullable): a GstMemory based on @allocator.
  * When the buffer will be released dmabuf allocator will close the @fd.
  * The memory is only mmapped on gst_buffer_map() request.
  *
@@ -169,7 +168,7 @@ gst_dmabuf_allocator_alloc (GstAllocator * allocator, gint fd, gsize size)
  *
  * Return a %GstMemory that wraps a dmabuf file descriptor.
  *
- * Returns: (transfer full): a GstMemory based on @allocator.
+ * Returns: (transfer full) (nullable): a GstMemory based on @allocator.
  *
  * When the buffer will be released the allocator will close the @fd unless
  * the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified.
diff --git a/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstfdmemory.c b/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstfdmemory.c
index 398914c852..e2e64d44a6 100644
--- a/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstfdmemory.c
+++ b/subprojects/gst-plugins-base/gst-libs/gst/allocators/gstfdmemory.c
@@ -246,9 +246,8 @@ gst_fd_allocator_init (GstFdAllocator * allocator)
  *
  * Return a new fd allocator.
  *
- * Returns: (transfer full): a new fd allocator, or NULL if the allocator
- *    isn't available. Use gst_object_unref() to release the allocator after
- *    usage
+ * Returns: (transfer full): a new fd allocator. Use gst_object_unref() to
+ * release the allocator after usage
  *
  * Since: 1.6
  */
@@ -272,7 +271,7 @@ gst_fd_allocator_new (void)
  *
  * Return a %GstMemory that wraps a generic file descriptor.
  *
- * Returns: (transfer full): a GstMemory based on @allocator.
+ * Returns: (transfer full) (nullable): a GstMemory based on @allocator.
  * When the buffer will be released the allocator will close the @fd unless
  * the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified.
  * The memory is only mmapped on gst_buffer_map() request.