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

gvarianttype: Improve docs on type validation

Browse Source 
Spotted by skrcprst.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
This commit is contained in:
Philip Withnall 2025-04-01 08:46:22 +01:00
parent 913a1bfd85
commit 18eb38fa15
No known key found for this signature in database
GPG Key ID: C5C42CFB268637CA
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
glib/gvarianttype.c
View File

@ -36,6 +36,19 @@
*
* A type in the [type@GLib.Variant] type system.
*
* [type@GLib.Variant] types are represented as strings, but have a strict
* syntax described below. All [type@GLib.VariantType]s passed to GLib must be
* valid, and they are typically expected to be static (i.e. not provided by
* user input) as they determine how binary [type@GLib.Variant] data is
* interpreted.
*
* To convert a static string to a [type@GLib.VariantType] in C, use the
* [func@GLib.VARIANT_TYPE] casting macro. When GLib is compiled with checks
* enabled, it will validate the type. To check if an arbitrary string is a
* valid [type@GLib.VariantType], use [func@GLib.VariantType.string_is_valid].
*
* ## GVariant Type System
*
* This section introduces the [type@GLib.Variant] type system. It is based, in
* large part, on the D-Bus type system, with two major changes and
* some minor lifting of restrictions. The