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

Add missing GVariant annotations

Browse Source 
https://bugzilla.gnome.org/show_bug.cgi?id=656031
This commit is contained in:
Pavel Holejsovsky 2011-08-05 16:31:06 +02:00 committed by Pavel Holejsovsky
parent cfa90b8fc1
commit 85d12096e4
3 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
glib/gvariant-core.c
View File

@ -801,7 +801,7 @@ g_variant_get_size (GVariant *value)
/** /**
* g_variant_get_data: * g_variant_get_data:
* @value: a #GVariant instance * @value: a #GVariant instance
* @returns: the serialised form of @value, or %NULL * @returns: (transfer none): the serialised form of @value, or %NULL
* *
* Returns a pointer to the serialised form of a #GVariant instance. * Returns a pointer to the serialised form of a #GVariant instance.
* The returned data may not be in fully-normalised form if read from an * The returned data may not be in fully-normalised form if read from an

12
glib/gvariant.c
View File

@ -1045,7 +1045,8 @@ g_variant_lookup_value (GVariant *dictionary,
* @value: a #GVariant array with fixed-sized elements * @value: a #GVariant array with fixed-sized elements
* @n_elements: (out): a pointer to the location to store the number of items * @n_elements: (out): a pointer to the location to store the number of items
* @element_size: the size of each element * @element_size: the size of each element
* @returns: (array length=n_elements): a pointer to the fixed array * @returns: (array length=n_elements) (transfer none): a pointer to
* the fixed array
* *
* Provides access to the serialised data for an array of fixed-sized * Provides access to the serialised data for an array of fixed-sized
* items. * items.
@ -1589,7 +1590,8 @@ g_variant_dup_objv (GVariant *value,
/** /**
* g_variant_new_bytestring: * g_variant_new_bytestring:
* @string: (array zero-terminated=1): a normal nul-terminated string in no particular encoding * @string: (array zero-terminated=1) (element-type guint8): a normal
* nul-terminated string in no particular encoding
* @returns: (transfer none): a floating reference to a new bytestring #GVariant instance * @returns: (transfer none): a floating reference to a new bytestring #GVariant instance
* *
* Creates an array-of-bytes #GVariant with the contents of @string. * Creates an array-of-bytes #GVariant with the contents of @string.
@ -1613,7 +1615,8 @@ g_variant_new_bytestring (const gchar *string)
/** /**
* g_variant_get_bytestring: * g_variant_get_bytestring:
* @value: an array-of-bytes #GVariant instance * @value: an array-of-bytes #GVariant instance
* @returns: (transfer none) (array zero-terminated=1): the constant string * @returns: (transfer none) (array zero-terminated=1) (element-type guint8):
* the constant string
* *
* Returns the string value of a #GVariant instance with an * Returns the string value of a #GVariant instance with an
* array-of-bytes type. The string has no particular encoding. * array-of-bytes type. The string has no particular encoding.
@ -1656,7 +1659,8 @@ g_variant_get_bytestring (GVariant *value)
* @value: an array-of-bytes #GVariant instance * @value: an array-of-bytes #GVariant instance
* @length: (out) (allow-none) (default NULL): a pointer to a #gsize, to store * @length: (out) (allow-none) (default NULL): a pointer to a #gsize, to store
* the length (not including the nul terminator) * the length (not including the nul terminator)
* @returns: (transfer full) (array zero-terminated=1): a newly allocated string * @returns: (transfer full) (array zero-terminated=1 length=length)
* (element-type guint8): a newly allocated string
* *
* Similar to g_variant_get_bytestring() except that instead of * Similar to g_variant_get_bytestring() except that instead of
* returning a constant string, the string is duplicated. * returning a constant string, the string is duplicated.

4
glib/gvarianttype.c
View File

@ -502,8 +502,8 @@ g_variant_type_check (const GVariantType *type)
/** /**
* g_variant_type_string_scan: * g_variant_type_string_scan:
* @string: a pointer to any string * @string: a pointer to any string
* @limit: the end of @string, or %NULL * @limit: (allow-none): the end of @string, or %NULL
* @endptr: location to store the end pointer, or %NULL * @endptr: (out) (allow-none): location to store the end pointer, or %NULL
* @returns: %TRUE if a valid type string was found * @returns: %TRUE if a valid type string was found
* *
* Scan for a single complete and valid GVariant type string in @string. * Scan for a single complete and valid GVariant type string in @string.