idstr: Fix docs of set_static_str_with_len()

The passed string must be NUL-terminated because otherwise a copy would be
necessary to make it NUL-terminated, which defeats the whole purpose of the
set_static() functions.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7863>
This commit is contained in:
Sebastian Dröge 2024-11-11 12:23:22 +02:00 committed by Backport Bot
parent c0c9a31fc9
commit bc63d85f19
2 changed files with 2 additions and 2 deletions

View file

@ -22233,7 +22233,7 @@ lifetime of the process, e.g. has to be a static string.</doc>
<doc xml:space="preserve" filename="../subprojects/gstreamer/gst/gstidstr.c">Sets @s to the string @value of length @len. @value needs to be valid for the
remaining lifetime of the process, e.g. has to be a static string.
@value does not have to be NUL-terminated and @len should not include the
@value must be NUL-terminated and @len should not include the
NUL-terminator.</doc>
<source-position filename="../subprojects/gstreamer/gst/gstidstr.h"/>
<return-value transfer-ownership="none">

View file

@ -158,7 +158,7 @@ gst_id_str_set_static_str (GstIdStr * s, const gchar * value)
* Sets @s to the string @value of length @len. @value needs to be valid for the
* remaining lifetime of the process, e.g. has to be a static string.
*
* @value does not have to be NUL-terminated and @len should not include the
* @value must be NUL-terminated and @len should not include the
* NUL-terminator.
*
* Since: 1.26