X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgvarianttype.c;h=b3e227a429d1075ec304281ec0ef34df218e06a4;hb=49a5d0f6f2aed99cd78f25655f137f4448e47d92;hp=2bdbcaac02ff6cada863422c863beadd30ad729d;hpb=1b033919845cef366842373da9f1cfb56f522d01;p=platform%2Fupstream%2Fglib.git
diff --git a/glib/gvarianttype.c b/glib/gvarianttype.c
index 2bdbcaa..b3e227a 100644
--- a/glib/gvarianttype.c
+++ b/glib/gvarianttype.c
@@ -13,9 +13,7 @@
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see .
*
* Author: Ryan Lortie
*/
@@ -36,18 +34,18 @@
* @short_description: introduction to the GVariant type system
* @see_also: #GVariantType, #GVariant
*
- * This section introduces the GVariant 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 DBus
- * specification, therefore, provides a significant amount of
+ * This section introduces the GVariant 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
+ * [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html),
+ * therefore, provides a significant amount of
* information that is useful when working with GVariant.
*
* The first major change with respect to the D-Bus type system is the
* introduction of maybe (or "nullable") types. Any type in GVariant can be
* converted to a maybe type, in which case, "nothing" (or "null") becomes a
* valid value. Maybe types have been added by introducing the
- * character "m" to type strings.
+ * character "m" to type strings.
*
* The second major change is that the GVariant type system supports the
* concept of "indefinite types" -- types that are less specific than
@@ -55,8 +53,7 @@
* of "an array of any type" in GVariant, where the D-Bus type system
* would require you to speak of "an array of integers" or "an array of
* strings". Indefinite types have been added by introducing the
- * characters "*", "?" and
- * "r" to type strings.
+ * characters "*", "?" and "r" to type strings.
*
* Finally, all arbitrary restrictions relating to the complexity of
* types are lifted along with the restriction that dictionary entries
@@ -94,406 +91,104 @@
* that the #GtkWindow is a #GtkBin (since #GtkWindow is a subclass of
* #GtkBin).
*
- * A detailed description of GVariant type strings is given here:
- *
- *
- * GVariant Type Strings
- *
- * A GVariant type string can be any of the following:
- *
- *
- *
- *
- * any basic type string (listed below)
- *
- *
- *
- *
- * "v", "r" or
- * "*"
- *
- *
- *
- *
- * one of the characters 'a' or
- * 'm', followed by another type string
- *
- *
- *
- *
- * the character '(', followed by a concatenation
- * of zero or more other type strings, followed by the character
- * ')'
- *
- *
- *
- *
- * the character '{', followed by a basic type
- * string (see below), followed by another type string, followed by
- * the character '}'
- *
- *
- *
- *
- * A basic type string describes a basic type (as per
- * g_variant_type_is_basic()) and is always a single
- * character in length. The valid basic type strings are
- * "b", "y",
- * "n", "q",
- * "i", "u",
- * "x", "t",
- * "h", "d",
- * "s", "o",
- * "g" and "?".
- *
- *
- * The above definition is recursive to arbitrary depth.
- * "aaaaai" and "(ui(nq((y)))s)"
- * are both valid type strings, as is
- * "a(aa(ui)(qna{ya(yd)}))".
- *
- *
- * The meaning of each of the characters is as follows:
- *
- *
- *
- *
- *
- *
- *
- * Character
- *
- *
- *
- *
- * Meaning
- *
- *
- *
- *
- *
- *
- * b
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_BOOLEAN; a boolean value.
- *
- *
- *
- *
- *
- *
- * y
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_BYTE; a byte.
- *
- *
- *
- *
- *
- *
- * n
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_INT16; a signed 16 bit
- * integer.
- *
- *
- *
- *
- *
- *
- * q
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_UINT16; an unsigned 16 bit
- * integer.
- *
- *
- *
- *
- *
- *
- * i
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_INT32; a signed 32 bit
- * integer.
- *
- *
- *
- *
- *
- *
- * u
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_UINT32; an unsigned 32 bit
- * integer.
- *
- *
- *
- *
- *
- *
- * x
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_INT64; a signed 64 bit
- * integer.
- *
- *
- *
- *
- *
- *
- * t
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_UINT64; an unsigned 64 bit
- * integer.
- *
- *
- *
- *
- *
- *
- * h
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_HANDLE; a signed 32 bit
- * value that, by convention, is used as an index into an array
- * of file descriptors that are sent alongside a D-Bus message.
- *
- *
- *
- *
- *
- *
- * d
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_DOUBLE; a double precision
- * floating point value.
- *
- *
- *
- *
- *
- *
- * s
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_STRING; a string.
- *
- *
- *
- *
- *
- *
- * o
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_OBJECT_PATH; a string in
- * the form of a D-Bus object path.
- *
- *
- *
- *
- *
- *
- * g
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_STRING; a string in the
- * form of a D-Bus type signature.
- *
- *
- *
- *
- *
- *
- * ?
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_BASIC; an indefinite type
- * that is a supertype of any of the basic types.
- *
- *
- *
- *
- *
- *
- * v
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_VARIANT; a container type
- * that contain any other type of value.
- *
- *
- *
- *
- *
- *
- * a
- *
- *
- *
- *
- * used as a prefix on another type string to mean an array of
- * that type; the type string "ai", for
- * example, is the type of an array of 32 bit signed integers.
- *
- *
- *
- *
- *
- *
- * m
- *
- *
- *
- *
- * used as a prefix on another type string to mean a "maybe", or
- * "nullable", version of that type; the type string
- * "ms", for example, is the type of a value
- * that maybe contains a string, or maybe contains nothing.
- *
- *
- *
- *
- *
- *
- * ()
- *
- *
- *
- *
- * used to enclose zero or more other concatenated type strings
- * to create a tuple type; the type string
- * "(is)", for example, is the type of a pair
- * of an integer and a string.
- *
- *
- *
- *
- *
- *
- * r
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_TUPLE; an indefinite type
- * that is a supertype of any tuple type, regardless of the
- * number of items.
- *
- *
- *
- *
- *
- *
- * {}
- *
- *
- *
- *
- * used to enclose a basic type string concatenated with another
- * type string to create a dictionary entry type, which usually
- * appears inside of an array to form a dictionary; the type
- * string "a{sd}", for example, is the type of
- * a dictionary that maps strings to double precision floating
- * point values.
- *
- *
- * The first type (the basic type) is the key type and the second
- * type is the value type. The reason that the first type is
- * restricted to being a basic type is so that it can easily be
- * hashed.
- *
- *
- *
- *
- *
- *
- * *
- *
- *
- *
- *
- * the type string of %G_VARIANT_TYPE_ANY; the indefinite type
- * that is a supertype of all types. Note that, as with all type
- * strings, this character represents exactly one type. It
- * cannot be used inside of tuples to mean "any number of items".
- *
- *
- *
- *
- *
- *
- *
- * Any type string of a container that contains an indefinite type is,
- * itself, an indefinite type. For example, the type string
- * "a*" (corresponding to %G_VARIANT_TYPE_ARRAY) is
- * an indefinite type that is a supertype of every array type.
- * "(*s)" is a supertype of all tuples that
- * contain exactly two items where the second item is a string.
- *
- *
- * "a{?*}" is an indefinite type that is a
- * supertype of all arrays containing dictionary entries where the key
- * is any basic type and the value is any type at all. This is, by
- * definition, a dictionary, so this type string corresponds to
- * %G_VARIANT_TYPE_DICTIONARY. Note that, due to the restriction that
- * the key of a dictionary entry must be a basic type,
- * "{**}" is not a valid type string.
- *
- *
+ * ## GVariant Type Strings
+ *
+ * A GVariant type string can be any of the following:
+ *
+ * - any basic type string (listed below)
+ *
+ * - "v", "r" or "*"
+ *
+ * - one of the characters 'a' or 'm', followed by another type string
+ *
+ * - the character '(', followed by a concatenation of zero or more other
+ * type strings, followed by the character ')'
+ *
+ * - the character '{', followed by a basic type string (see below),
+ * followed by another type string, followed by the character '}'
+ *
+ * A basic type string describes a basic type (as per
+ * g_variant_type_is_basic()) and is always a single character in length.
+ * The valid basic type strings are "b", "y", "n", "q", "i", "u", "x", "t",
+ * "h", "d", "s", "o", "g" and "?".
+ *
+ * The above definition is recursive to arbitrary depth. "aaaaai" and
+ * "(ui(nq((y)))s)" are both valid type strings, as is
+ * "a(aa(ui)(qna{ya(yd)}))".
+ *
+ * The meaning of each of the characters is as follows:
+ * - `b`: the type string of %G_VARIANT_TYPE_BOOLEAN; a boolean value.
+ * - `y`: the type string of %G_VARIANT_TYPE_BYTE; a byte.
+ * - `n`: the type string of %G_VARIANT_TYPE_INT16; a signed 16 bit integer.
+ * - `q`: the type string of %G_VARIANT_TYPE_UINT16; an unsigned 16 bit integer.
+ * - `i`: the type string of %G_VARIANT_TYPE_INT32; a signed 32 bit integer.
+ * - `u`: the type string of %G_VARIANT_TYPE_UINT32; an unsigned 32 bit integer.
+ * - `x`: the type string of %G_VARIANT_TYPE_INT64; a signed 64 bit integer.
+ * - `t`: the type string of %G_VARIANT_TYPE_UINT64; an unsigned 64 bit integer.
+ * - `h`: the type string of %G_VARIANT_TYPE_HANDLE; a signed 32 bit value
+ * that, by convention, is used as an index into an array of file
+ * descriptors that are sent alongside a D-Bus message.
+ * - `d`: the type string of %G_VARIANT_TYPE_DOUBLE; a double precision
+ * floating point value.
+ * - `s`: the type string of %G_VARIANT_TYPE_STRING; a string.
+ * - `o`: the type string of %G_VARIANT_TYPE_OBJECT_PATH; a string in the form
+ * of a D-Bus object path.
+ * - `g`: the type string of %G_VARIANT_TYPE_STRING; a string in the form of
+ * a D-Bus type signature.
+ * - `?`: the type string of %G_VARIANT_TYPE_BASIC; an indefinite type that
+ * is a supertype of any of the basic types.
+ * - `v`: the type string of %G_VARIANT_TYPE_VARIANT; a container type that
+ * contain any other type of value.
+ * - `a`: used as a prefix on another type string to mean an array of that
+ * type; the type string "ai", for example, is the type of an array of
+ * signed 32-bit integers.
+ * - `m`: used as a prefix on another type string to mean a "maybe", or
+ * "nullable", version of that type; the type string "ms", for example,
+ * is the type of a value that maybe contains a string, or maybe contains
+ * nothing.
+ * - `()`: used to enclose zero or more other concatenated type strings to
+ * create a tuple type; the type string "(is)", for example, is the type of
+ * a pair of an integer and a string.
+ * - `r`: the type string of %G_VARIANT_TYPE_TUPLE; an indefinite type that is
+ * a supertype of any tuple type, regardless of the number of items.
+ * - `{}`: used to enclose a basic type string concatenated with another type
+ * string to create a dictionary entry type, which usually appears inside of
+ * an array to form a dictionary; the type string "a{sd}", for example, is
+ * the type of a dictionary that maps strings to double precision floating
+ * point values.
+ *
+ * The first type (the basic type) is the key type and the second type is
+ * the value type. The reason that the first type is restricted to being a
+ * basic type is so that it can easily be hashed.
+ * - `*`: the type string of %G_VARIANT_TYPE_ANY; the indefinite type that is
+ * a supertype of all types. Note that, as with all type strings, this
+ * character represents exactly one type. It cannot be used inside of tuples
+ * to mean "any number of items".
+ *
+ * Any type string of a container that contains an indefinite type is,
+ * itself, an indefinite type. For example, the type string "a*"
+ * (corresponding to %G_VARIANT_TYPE_ARRAY) is an indefinite type
+ * that is a supertype of every array type. "(*s)" is a supertype
+ * of all tuples that contain exactly two items where the second
+ * item is a string.
+ *
+ * "a{?*}" is an indefinite type that is a supertype of all arrays
+ * containing dictionary entries where the key is any basic type and
+ * the value is any type at all. This is, by definition, a dictionary,
+ * so this type string corresponds to %G_VARIANT_TYPE_DICTIONARY. Note
+ * that, due to the restriction that the key of a dictionary entry must
+ * be a basic type, "{**}" is not a valid type string.
*/
static gboolean
g_variant_type_check (const GVariantType *type)
{
- const gchar *type_string;
-
if (type == NULL)
return FALSE;
- type_string = (const gchar *) type;
-#ifndef G_DISABLE_CHECKS
- return g_variant_type_string_scan (type_string, NULL, NULL);
+#if 0
+ return g_variant_type_string_scan ((const gchar *) type, NULL, NULL);
#else
return TRUE;
#endif
@@ -504,7 +199,6 @@ g_variant_type_check (const GVariantType *type)
* @string: a pointer to any string
* @limit: (allow-none): the end of @string, or %NULL
* @endptr: (out) (allow-none): location to store the end pointer, or %NULL
- * @returns: %TRUE if a valid type string was found
*
* Scan for a single complete and valid GVariant type string in @string.
* The memory pointed to by @limit (or bytes beyond it) is never
@@ -520,6 +214,8 @@ g_variant_type_check (const GVariantType *type)
* For the simple case of checking if a string is a valid type string,
* see g_variant_type_string_is_valid().
*
+ * Returns: %TRUE if a valid type string was found
+ *
* Since: 2.24
**/
gboolean
@@ -572,12 +268,13 @@ g_variant_type_string_scan (const gchar *string,
/**
* g_variant_type_string_is_valid:
* @type_string: a pointer to any string
- * @returns: %TRUE if @type_string is exactly one valid type string
*
* Checks if @type_string is a valid GVariant type string. This call is
* equivalent to calling g_variant_type_string_scan() and confirming
* that the following character is a nul terminator.
*
+ * Returns: %TRUE if @type_string is exactly one valid type string
+ *
* Since 2.24
**/
gboolean
@@ -595,7 +292,7 @@ g_variant_type_string_is_valid (const gchar *type_string)
/**
* g_variant_type_free:
- * @type: a #GVariantType, or %NULL
+ * @type: (allow-none): a #GVariantType, or %NULL
*
* Frees a #GVariantType that was allocated with
* g_variant_type_copy(), g_variant_type_new() or one of the container
@@ -616,11 +313,12 @@ g_variant_type_free (GVariantType *type)
/**
* g_variant_type_copy:
* @type: a #GVariantType
- * @returns: (transfer full): a new #GVariantType
*
* Makes a copy of a #GVariantType. It is appropriate to call
* g_variant_type_free() on the return value. @type may not be %NULL.
*
+ * Returns: (transfer full): a new #GVariantType
+ *
* Since 2.24
**/
GVariantType *
@@ -643,7 +341,6 @@ g_variant_type_copy (const GVariantType *type)
/**
* g_variant_type_new:
* @type_string: a valid GVariant type string
- * @returns: (transfer full): a new #GVariantType
*
* Creates a new #GVariantType corresponding to the type string given
* by @type_string. It is appropriate to call g_variant_type_free() on
@@ -652,6 +349,8 @@ g_variant_type_copy (const GVariantType *type)
* It is a programmer error to call this function with an invalid type
* string. Use g_variant_type_string_is_valid() if you are unsure.
*
+ * Returns: (transfer full): a new #GVariantType
+ *
* Since: 2.24
*/
GVariantType *
@@ -665,12 +364,13 @@ g_variant_type_new (const gchar *type_string)
/**
* g_variant_type_get_string_length:
* @type: a #GVariantType
- * @returns: the length of the corresponding type string
*
* Returns the length of the type string corresponding to the given
* @type. This function must be used to determine the valid extent of
* the memory region returned by g_variant_type_peek_string().
*
+ * Returns: the length of the corresponding type string
+ *
* Since 2.24
**/
gsize
@@ -707,7 +407,6 @@ g_variant_type_get_string_length (const GVariantType *type)
/**
* g_variant_type_peek_string: (skip)
* @type: a #GVariantType
- * @returns: the corresponding type string (not nul-terminated)
*
* Returns the type string corresponding to the given @type. The
* result is not nul-terminated; in order to determine its length you
@@ -715,6 +414,8 @@ g_variant_type_get_string_length (const GVariantType *type)
*
* To get a nul-terminated string, see g_variant_type_dup_string().
*
+ * Returns: the corresponding type string (not nul-terminated)
+ *
* Since 2.24
**/
const gchar *
@@ -728,12 +429,13 @@ g_variant_type_peek_string (const GVariantType *type)
/**
* g_variant_type_dup_string:
* @type: a #GVariantType
- * @returns: (transfer full): the corresponding type string
*
* Returns a newly-allocated copy of the type string corresponding to
* @type. The returned string is nul-terminated. It is appropriate to
* call g_free() on the return value.
*
+ * Returns: (transfer full): the corresponding type string
+ *
* Since 2.24
**/
gchar *
@@ -748,7 +450,6 @@ g_variant_type_dup_string (const GVariantType *type)
/**
* g_variant_type_is_definite:
* @type: a #GVariantType
- * @returns: %TRUE if @type is definite
*
* Determines if the given @type is definite (ie: not indefinite).
*
@@ -761,6 +462,8 @@ g_variant_type_dup_string (const GVariantType *type)
* indefinite type like %G_VARIANT_TYPE_ARRAY, however, will result in
* %FALSE being returned.
*
+ * Returns: %TRUE if @type is definite
+ *
* Since 2.24
**/
gboolean
@@ -787,7 +490,6 @@ g_variant_type_is_definite (const GVariantType *type)
/**
* g_variant_type_is_container:
* @type: a #GVariantType
- * @returns: %TRUE if @type is a container type
*
* Determines if the given @type is a container type.
*
@@ -798,6 +500,8 @@ g_variant_type_is_definite (const GVariantType *type)
* definite subtype is a container -- %G_VARIANT_TYPE_ARRAY, for
* example.
*
+ * Returns: %TRUE if @type is a container type
+ *
* Since 2.24
**/
gboolean
@@ -826,7 +530,6 @@ g_variant_type_is_container (const GVariantType *type)
/**
* g_variant_type_is_basic:
* @type: a #GVariantType
- * @returns: %TRUE if @type is a basic type
*
* Determines if the given @type is a basic type.
*
@@ -838,6 +541,8 @@ g_variant_type_is_container (const GVariantType *type)
* This function returns %FALSE for all indefinite types except
* %G_VARIANT_TYPE_BASIC.
*
+ * Returns: %TRUE if @type is a basic type
+ *
* Since 2.24
**/
gboolean
@@ -874,7 +579,6 @@ g_variant_type_is_basic (const GVariantType *type)
/**
* g_variant_type_is_maybe:
* @type: a #GVariantType
- * @returns: %TRUE if @type is a maybe type
*
* Determines if the given @type is a maybe type. This is true if the
* type string for @type starts with an 'm'.
@@ -883,6 +587,8 @@ g_variant_type_is_basic (const GVariantType *type)
* definite subtype is a maybe type -- %G_VARIANT_TYPE_MAYBE, for
* example.
*
+ * Returns: %TRUE if @type is a maybe type
+ *
* Since 2.24
**/
gboolean
@@ -896,7 +602,6 @@ g_variant_type_is_maybe (const GVariantType *type)
/**
* g_variant_type_is_array:
* @type: a #GVariantType
- * @returns: %TRUE if @type is an array type
*
* Determines if the given @type is an array type. This is true if the
* type string for @type starts with an 'a'.
@@ -905,6 +610,8 @@ g_variant_type_is_maybe (const GVariantType *type)
* definite subtype is an array type -- %G_VARIANT_TYPE_ARRAY, for
* example.
*
+ * Returns: %TRUE if @type is an array type
+ *
* Since 2.24
**/
gboolean
@@ -918,7 +625,6 @@ g_variant_type_is_array (const GVariantType *type)
/**
* g_variant_type_is_tuple:
* @type: a #GVariantType
- * @returns: %TRUE if @type is a tuple type
*
* Determines if the given @type is a tuple type. This is true if the
* type string for @type starts with a '(' or if @type is
@@ -928,6 +634,8 @@ g_variant_type_is_array (const GVariantType *type)
* definite subtype is a tuple type -- %G_VARIANT_TYPE_TUPLE, for
* example.
*
+ * Returns: %TRUE if @type is a tuple type
+ *
* Since 2.24
**/
gboolean
@@ -944,7 +652,6 @@ g_variant_type_is_tuple (const GVariantType *type)
/**
* g_variant_type_is_dict_entry:
* @type: a #GVariantType
- * @returns: %TRUE if @type is a dictionary entry type
*
* Determines if the given @type is a dictionary entry type. This is
* true if the type string for @type starts with a '{'.
@@ -953,6 +660,8 @@ g_variant_type_is_tuple (const GVariantType *type)
* definite subtype is a dictionary entry type --
* %G_VARIANT_TYPE_DICT_ENTRY, for example.
*
+ * Returns: %TRUE if @type is a dictionary entry type
+ *
* Since 2.24
**/
gboolean
@@ -966,10 +675,11 @@ g_variant_type_is_dict_entry (const GVariantType *type)
/**
* g_variant_type_is_variant:
* @type: a #GVariantType
- * @returns: %TRUE if @type is the variant type
*
* Determines if the given @type is the variant type.
*
+ * Returns: %TRUE if @type is the variant type
+ *
* Since 2.24
**/
gboolean
@@ -983,7 +693,6 @@ g_variant_type_is_variant (const GVariantType *type)
/**
* g_variant_type_hash:
* @type: (type GVariantType): a #GVariantType
- * @returns: the hash value
*
* Hashes @type.
*
@@ -991,6 +700,8 @@ g_variant_type_is_variant (const GVariantType *type)
* #GHashTable without function pointer casting. A valid
* #GVariantType must be provided.
*
+ * Returns: the hash value
+ *
* Since 2.24
**/
guint
@@ -1016,7 +727,6 @@ g_variant_type_hash (gconstpointer type)
* g_variant_type_equal:
* @type1: (type GVariantType): a #GVariantType
* @type2: (type GVariantType): a #GVariantType
- * @returns: %TRUE if @type1 and @type2 are exactly equal
*
* Compares @type1 and @type2 for equality.
*
@@ -1029,6 +739,8 @@ g_variant_type_hash (gconstpointer type)
* allow use with #GHashTable without function pointer casting. For
* both arguments, a valid #GVariantType must be provided.
*
+ * Returns: %TRUE if @type1 and @type2 are exactly equal
+ *
* Since 2.24
**/
gboolean
@@ -1060,7 +772,6 @@ g_variant_type_equal (gconstpointer type1,
* g_variant_type_is_subtype_of:
* @type: a #GVariantType
* @supertype: a #GVariantType
- * @returns: %TRUE if @type is a subtype of @supertype
*
* Checks if @type is a subtype of @supertype.
*
@@ -1068,6 +779,8 @@ g_variant_type_equal (gconstpointer type1,
* types are considered to be subtypes of themselves. Aside from that,
* only indefinite types can have subtypes.
*
+ * Returns: %TRUE if @type is a subtype of @supertype
+ *
* Since 2.24
**/
gboolean
@@ -1133,12 +846,13 @@ g_variant_type_is_subtype_of (const GVariantType *type,
/**
* g_variant_type_element:
* @type: an array or maybe #GVariantType
- * @returns: (transfer none): the element type of @type
*
* Determines the element type of an array or maybe type.
*
* This function may only be used with array or maybe types.
*
+ * Returns: (transfer none): the element type of @type
+ *
* Since 2.24
**/
const GVariantType *
@@ -1158,7 +872,6 @@ g_variant_type_element (const GVariantType *type)
/**
* g_variant_type_first:
* @type: a tuple or dictionary entry #GVariantType
- * @returns: (transfer none): the first item type of @type, or %NULL
*
* Determines the first item type of a tuple or dictionary entry
* type.
@@ -1175,6 +888,8 @@ g_variant_type_element (const GVariantType *type)
* This call, together with g_variant_type_next() provides an iterator
* interface over tuple and dictionary entry types.
*
+ * Returns: (transfer none): the first item type of @type, or %NULL
+ *
* Since 2.24
**/
const GVariantType *
@@ -1196,7 +911,6 @@ g_variant_type_first (const GVariantType *type)
/**
* g_variant_type_next:
* @type: a #GVariantType from a previous call
- * @returns: (transfer none): the next #GVariantType after @type, or %NULL
*
* Determines the next item type of a tuple or dictionary entry
* type.
@@ -1210,6 +924,8 @@ g_variant_type_first (const GVariantType *type)
*
* For tuples, %NULL is returned when @type is the last item in a tuple.
*
+ * Returns: (transfer none): the next #GVariantType after @type, or %NULL
+ *
* Since 2.24
**/
const GVariantType *
@@ -1231,7 +947,6 @@ g_variant_type_next (const GVariantType *type)
/**
* g_variant_type_n_items:
* @type: a tuple or dictionary entry #GVariantType
- * @returns: the number of items in @type
*
* Determines the number of items contained in a tuple or
* dictionary entry type.
@@ -1243,6 +958,8 @@ g_variant_type_next (const GVariantType *type)
* In the case of a dictionary entry type, this function will always
* return 2.
*
+ * Returns: the number of items in @type
+ *
* Since 2.24
**/
gsize
@@ -1263,7 +980,6 @@ g_variant_type_n_items (const GVariantType *type)
/**
* g_variant_type_key:
* @type: a dictionary entry #GVariantType
- * @returns: (transfer none): the key type of the dictionary entry
*
* Determines the key type of a dictionary entry type.
*
@@ -1271,6 +987,8 @@ g_variant_type_n_items (const GVariantType *type)
* than the additional restriction, this call is equivalent to
* g_variant_type_first().
*
+ * Returns: (transfer none): the key type of the dictionary entry
+ *
* Since 2.24
**/
const GVariantType *
@@ -1289,12 +1007,13 @@ g_variant_type_key (const GVariantType *type)
/**
* g_variant_type_value:
* @type: a dictionary entry #GVariantType
- * @returns: (transfer none): the value type of the dictionary entry
*
* Determines the value type of a dictionary entry type.
*
* This function may only be used with a dictionary entry type.
*
+ * Returns: (transfer none): the value type of the dictionary entry
+ *
* Since 2.24
**/
const GVariantType *
@@ -1314,7 +1033,6 @@ g_variant_type_value (const GVariantType *type)
* g_variant_type_new_tuple:
* @items: (array length=length): an array of #GVariantTypes, one for each item
* @length: the length of @items, or -1
- * @returns: (transfer full): a new tuple #GVariantType
*
* Constructs a new tuple type, from @items.
*
@@ -1323,6 +1041,8 @@ g_variant_type_value (const GVariantType *type)
*
* It is appropriate to call g_variant_type_free() on the return value.
*
+ * Returns: (transfer full): a new tuple #GVariantType
+ *
* Since 2.24
**/
static GVariantType *
@@ -1393,15 +1113,16 @@ g_variant_type_new_tuple (const GVariantType * const *items,
}
/**
- * g_variant_type_new_array:
+ * g_variant_type_new_array: (constructor)
* @element: a #GVariantType
- * @returns: (transfer full): a new array #GVariantType
*
* Constructs the type corresponding to an array of elements of the
* type @type.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
+ * Returns: (transfer full): a new array #GVariantType
+ *
* Since 2.24
**/
GVariantType *
@@ -1422,15 +1143,16 @@ g_variant_type_new_array (const GVariantType *element)
}
/**
- * g_variant_type_new_maybe:
+ * g_variant_type_new_maybe: (constructor)
* @element: a #GVariantType
- * @returns: (transfer full): a new maybe #GVariantType
*
* Constructs the type corresponding to a maybe instance containing
* type @type or Nothing.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
+ * Returns: (transfer full): a new maybe #GVariantType
+ *
* Since 2.24
**/
GVariantType *
@@ -1451,16 +1173,17 @@ g_variant_type_new_maybe (const GVariantType *element)
}
/**
- * g_variant_type_new_dict_entry:
+ * g_variant_type_new_dict_entry: (constructor)
* @key: a basic #GVariantType
* @value: a #GVariantType
- * @returns: (transfer full): a new dictionary entry #GVariantType
*
* Constructs the type corresponding to a dictionary entry with a key
* of type @key and a value of type @value.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
+ * Returns: (transfer full): a new dictionary entry #GVariantType
+ *
* Since 2.24
**/
GVariantType *