luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-07-06 02:37:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

gstrfuncs: Mention slightly odd return types in docs

Browse Source 
See the previous commit for details.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3286
This commit is contained in:
Philip Withnall 2024-03-13 15:06:34 +00:00
parent 6c3ad23634
commit e0c18a2f04
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
glib/gstrfuncs.c
View File

@ -2732,6 +2732,9 @@ g_strjoin (const gchar *separator,
* A length of `-1` can be used to mean “search the entire string”, like * A length of `-1` can be used to mean “search the entire string”, like
* `strstr()`. * `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 * Returns: (transfer none) (nullable): a pointer to the found occurrence, or
* `NULL` if not found * `NULL` if not found
*/ */
@ -2785,6 +2788,9 @@ g_strstr_len (const gchar *haystack,
* Searches the string @haystack for the last occurrence * Searches the string @haystack for the last occurrence
* of the string @needle. * 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 * Returns: (transfer none) (nullable): a pointer to the found occurrence, or
* `NULL` if not found * `NULL` if not found
*/ */
@ -2837,6 +2843,9 @@ g_strrstr (const gchar *haystack,
* of the string @needle, limiting the length of the search * of the string @needle, limiting the length of the search
* to @haystack_len. * 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 * Returns: (transfer none) (nullable): a pointer to the found occurrence, or
* `NULL` if not found * `NULL` if not found
*/ */