From e0c18a2f048a8d5d0fe4d13fbc55abd40d13debf Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Wed, 13 Mar 2024 15:06:34 +0000 Subject: [PATCH] gstrfuncs: Mention slightly odd return types in docs See the previous commit for details. Signed-off-by: Philip Withnall Helps: #3286 --- glib/gstrfuncs.c | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c index e1afddf47..9af21a953 100644 --- a/glib/gstrfuncs.c +++ b/glib/gstrfuncs.c @@ -2732,6 +2732,9 @@ g_strjoin (const gchar *separator, * A length of `-1` can be used to mean “search the entire string”, like * `strstr()`. * + * The fact that this function returns `gchar *` rather than `const gchar *` is + * a historical artifact. + * * Returns: (transfer none) (nullable): a pointer to the found occurrence, or * `NULL` if not found */ @@ -2785,6 +2788,9 @@ g_strstr_len (const gchar *haystack, * Searches the string @haystack for the last occurrence * of the string @needle. * + * The fact that this function returns `gchar *` rather than `const gchar *` is + * a historical artifact. + * * Returns: (transfer none) (nullable): a pointer to the found occurrence, or * `NULL` if not found */ @@ -2837,6 +2843,9 @@ g_strrstr (const gchar *haystack, * of the string @needle, limiting the length of the search * to @haystack_len. * + * The fact that this function returns `gchar *` rather than `const gchar *` is + * a historical artifact. + * * Returns: (transfer none) (nullable): a pointer to the found occurrence, or * `NULL` if not found */