gdbusutils: Add an example to g_dbus_gvariant_to_gvalue() docs

Clarify that GVariants of type v are not magically unboxed.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=784433
This commit is contained in:
Philip Withnall 2017-07-04 10:21:38 +01:00
parent 9bc3d025f9
commit 5a8b02cae6

View File

@ -358,7 +358,11 @@ g_dbus_is_guid (const gchar *string)
* Converts a #GVariant to a #GValue. If @value is floating, it is consumed.
*
* The rules specified in the g_dbus_gvalue_to_gvariant() function are
* used - this function is essentially its reverse form.
* used - this function is essentially its reverse form. So, a #GVariant
* containing any basic or string array type will be converted to a #GValue
* containing a basic value or string array. Any other #GVariant (handle,
* variant, tuple, dict entry) will be converted to a #GValue containing that
* #GVariant.
*
* The conversion never fails - a valid #GValue is always returned in
* @out_gvalue.