bufferlist: get() is not actually nullable in its return value

Passing an out of bounds index is the only way to get a NULL buffer but
this causes an assertion so is not to be considered for the
annotations.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6884>
This commit is contained in:
Sebastian Dröge 2024-05-21 08:24:51 +03:00 committed by GStreamer Marge Bot
parent 0f8b599ded
commit 1a8e7aa92d
2 changed files with 11 additions and 11 deletions

View file

@ -3739,10 +3739,10 @@ the list should be skipped.</doc>
You must make sure that @idx does not exceed the number of You must make sure that @idx does not exceed the number of
buffers available.</doc> buffers available.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstbufferlist.h"/> <source-position filename="../subprojects/gstreamer/gst/gstbufferlist.h"/>
<return-value transfer-ownership="none" nullable="1"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstbufferlist.c">the buffer at @idx in @group <doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstbufferlist.c">the buffer at @idx in @group.
or %NULL when there is no buffer. The buffer remains valid as The returned buffer remains valid as long as @list is valid and
long as @list is valid and buffer is not removed from the list.</doc> buffer is not removed from the list.</doc>
<type name="Buffer" c:type="GstBuffer*"/> <type name="Buffer" c:type="GstBuffer*"/>
</return-value> </return-value>
<parameters> <parameters>
@ -3762,9 +3762,9 @@ buffers available.</doc>
You must make sure that @idx does not exceed the number of You must make sure that @idx does not exceed the number of
buffers available.</doc> buffers available.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstbufferlist.h"/> <source-position filename="../subprojects/gstreamer/gst/gstbufferlist.h"/>
<return-value transfer-ownership="none" nullable="1"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstbufferlist.c">the buffer at @idx in @group. <doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstbufferlist.c">the buffer at @idx in @group.
The returned buffer remains valid as long as @list is valid and The returned buffer remains valid as long as @list is valid and
the buffer is not removed from the list.</doc> the buffer is not removed from the list.</doc>
<type name="Buffer" c:type="GstBuffer*"/> <type name="Buffer" c:type="GstBuffer*"/>
</return-value> </return-value>

View file

@ -332,9 +332,9 @@ gst_buffer_list_foreach (GstBufferList * list, GstBufferListFunc func,
* You must make sure that @idx does not exceed the number of * You must make sure that @idx does not exceed the number of
* buffers available. * buffers available.
* *
* Returns: (transfer none) (nullable): the buffer at @idx in @group * Returns: (transfer none): the buffer at @idx in @group.
* or %NULL when there is no buffer. The buffer remains valid as * The returned buffer remains valid as long as @list is valid and
* long as @list is valid and buffer is not removed from the list. * buffer is not removed from the list.
*/ */
GstBuffer * GstBuffer *
gst_buffer_list_get (GstBufferList * list, guint idx) gst_buffer_list_get (GstBufferList * list, guint idx)
@ -355,8 +355,8 @@ gst_buffer_list_get (GstBufferList * list, guint idx)
* You must make sure that @idx does not exceed the number of * You must make sure that @idx does not exceed the number of
* buffers available. * buffers available.
* *
* Returns: (transfer none) (nullable): the buffer at @idx in @group. * Returns: (transfer none): the buffer at @idx in @group.
* The returned buffer remains valid as long as @list is valid and * The returned buffer remains valid as long as @list is valid and
* the buffer is not removed from the list. * the buffer is not removed from the list.
* *
* Since: 1.14 * Since: 1.14