Clarify GValue documentation

This commit is contained in:
DarkTrick 2021-07-12 10:40:33 +00:00 committed by Philip Withnall
parent cd93c350a2
commit 80189ca892
2 changed files with 12 additions and 1 deletions

View File

@ -52,6 +52,9 @@
* Parameter names need to start with a letter (a-z or A-Z). Subsequent * Parameter names need to start with a letter (a-z or A-Z). Subsequent
* characters can be letters, numbers or a '-'. * characters can be letters, numbers or a '-'.
* All other characters are replaced by a '-' during construction. * All other characters are replaced by a '-' during construction.
*
* See also #GValue for more information.
*
*/ */

View File

@ -44,9 +44,13 @@
* of a type identifier and a specific value of that type. * of a type identifier and a specific value of that type.
* The type identifier within a #GValue structure always determines the * The type identifier within a #GValue structure always determines the
* type of the associated value. * type of the associated value.
*
* To create an undefined #GValue structure, simply create a zero-filled * To create an undefined #GValue structure, simply create a zero-filled
* #GValue structure. To initialize the #GValue, use the g_value_init() * #GValue structure. To initialize the #GValue, use the g_value_init()
* function. A #GValue cannot be used until it is initialized. * function. A #GValue cannot be used until it is initialized. Before
* destruction you must always use g_value_unset() to make sure allocated
* memory is freed.
*
* The basic type operations (such as freeing and copying) are determined * The basic type operations (such as freeing and copying) are determined
* by the #GTypeValueTable associated with the type ID stored in the #GValue. * by the #GTypeValueTable associated with the type ID stored in the #GValue.
* Other #GValue operations (such as converting values between types) are * Other #GValue operations (such as converting values between types) are
@ -109,6 +113,10 @@
* return 0; * return 0;
* } * }
* ]| * ]|
*
* See also [gobject-Standard-Parameter-and-Value-Types] for more information on
* validation of #GValue.
*
*/ */