mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-08 23:42:28 +00:00
Code Issues 1 Projects Releases Wiki Activity

allocators: Add/fix various annotations

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3194>
This commit is contained in:
Sebastian Dröge 2022-10-17 11:31:05 +03:00
parent 2f0e195709
commit 2b91f7e165
2 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
subprojects/gst-plugins-base/gst-libs/gst/allocators/gstdmabuf.c
View file

@ -121,9 +121,8 @@ gst_dmabuf_allocator_init (GstDmaBufAllocator * allocator)
* *
* Return a new dmabuf allocator. * Return a new dmabuf allocator.
* *
* Returns: (transfer full): a new dmabuf allocator, or NULL if the allocator * Returns: (transfer full): a new dmabuf allocator. Use gst_object_unref() to
* isn't available. Use gst_object_unref() to release the allocator after * release the allocator after usage
* usage
* *
* Since: 1.2 * Since: 1.2
*/ */
@ -146,7 +145,7 @@ gst_dmabuf_allocator_new (void)
* *
* Return a %GstMemory that wraps a dmabuf file descriptor. * 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. * When the buffer will be released dmabuf allocator will close the @fd.
* The memory is only mmapped on gst_buffer_map() request. * 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. * 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 * When the buffer will be released the allocator will close the @fd unless
* the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified. * the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified.

7
subprojects/gst-plugins-base/gst-libs/gst/allocators/gstfdmemory.c
View file

@ -246,9 +246,8 @@ gst_fd_allocator_init (GstFdAllocator * allocator)
* *
* Return a new fd allocator. * Return a new fd allocator.
* *
* Returns: (transfer full): a new fd allocator, or NULL if the allocator * Returns: (transfer full): a new fd allocator. Use gst_object_unref() to
* isn't available. Use gst_object_unref() to release the allocator after * release the allocator after usage
* usage
* *
* Since: 1.6 * Since: 1.6
*/ */
@ -272,7 +271,7 @@ gst_fd_allocator_new (void)
* *
* Return a %GstMemory that wraps a generic file descriptor. * 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 * When the buffer will be released the allocator will close the @fd unless
* the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified. * the %GST_FD_MEMORY_FLAG_DONT_CLOSE flag is specified.
* The memory is only mmapped on gst_buffer_map() request. * The memory is only mmapped on gst_buffer_map() request.