From: Mathieu Duponchelle <mathieu@centricular.com>
Date: Tue, 2 Feb 2021 15:41:28 +0000 (+0100)
Subject: docs: clean up GstAllocator documentation
X-Git-Tag: 1.19.3~624
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a1974341fe3d5391b52ee9c05c48506009a6f162;p=platform%2Fupstream%2Fgstreamer.git

docs: clean up GstAllocator documentation

In particular, there is no need to explicitly mention free
functions / ownership transfers, this should be obvious from
the annotations.

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

diff --git a/gst/gstallocator.c b/gst/gstallocator.c
index 3dd39f5..ccfc6aa 100644
--- a/gst/gstallocator.c
+++ b/gst/gstallocator.c
@@ -162,10 +162,7 @@ gst_allocation_params_init (GstAllocationParams * params)
  *
  * Create a copy of @params.
  *
- * Free-function: gst_allocation_params_free
- *
- * Returns: (transfer full) (nullable): a new ##GstAllocationParams, free with
- * gst_allocation_params_free().
+ * Returns: (transfer full) (nullable): a new #GstAllocationParams.
  */
 GstAllocationParams *
 gst_allocation_params_copy (const GstAllocationParams * params)
@@ -197,8 +194,7 @@ gst_allocation_params_free (GstAllocationParams * params)
  * @name: the name of the allocator
  * @allocator: (transfer full): #GstAllocator
  *
- * Registers the memory @allocator with @name. This function takes ownership of
- * @allocator.
+ * Registers the memory @allocator with @name.
  */
 void
 gst_allocator_register (const gchar * name, GstAllocator * allocator)
@@ -224,8 +220,7 @@ gst_allocator_register (const gchar * name, GstAllocator * allocator)
  * default allocator will be returned.
  *
  * Returns: (transfer full) (nullable): a #GstAllocator or %NULL when
- * the allocator with @name was not registered. Use gst_object_unref()
- * to release the allocator after usage.
+ * the allocator with @name was not registered.
  */
 GstAllocator *
 gst_allocator_find (const gchar * name)
@@ -249,7 +244,7 @@ gst_allocator_find (const gchar * name)
  * gst_allocator_set_default:
  * @allocator: (transfer full): a #GstAllocator
  *
- * Set the default allocator. This function takes ownership of @allocator.
+ * Set the default allocator.
  */
 void
 gst_allocator_set_default (GstAllocator * allocator)