luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-04 10:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'variant-get-string-docs' into 'master'

Browse Source 
gvariant: Fix documentation for g_variant_get_string() to match reality

See merge request GNOME/glib!1531
This commit is contained in:
Sebastian Dröge 2020-06-17 07:45:22 +00:00
commit ff7d5b36e7
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
glib/gvariant.c
View File

@ -1440,11 +1440,15 @@ g_variant_is_signature (const gchar *string)
* type. This includes the types %G_VARIANT_TYPE_STRING, * type. This includes the types %G_VARIANT_TYPE_STRING,
* %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE. * %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE.
* *
* The string will always be UTF-8 encoded, and will never be %NULL. * The string will always be UTF-8 encoded, will never be %NULL, and will never
* contain nul bytes.
* *
* If @length is non-%NULL then the length of the string (in bytes) is * If @length is non-%NULL then the length of the string (in bytes) is
* returned there. For trusted values, this information is already * returned there. For trusted values, this information is already
* known. For untrusted values, a strlen() will be performed. * known. Untrusted values will be validated and, if valid, a strlen() will be
* performed. If invalid, a default value will be returned — for
* %G_VARIANT_TYPE_OBJECT_PATH, this is `"/"`, and for other types it is the
* empty string.
* *
* It is an error to call this function with a @value of any type * It is an error to call this function with a @value of any type
* other than those three. * other than those three.