[glib: 1/2] Clarify GValue documentation
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib: 1/2] Clarify GValue documentation
- Date: Mon, 12 Jul 2021 10:40:35 +0000 (UTC)
commit 80189ca8923184e435e645cd5af4628e1a2891e0
Author: DarkTrick <notebook22312 gmail com>
Date: Mon Jul 12 10:40:33 2021 +0000
Clarify GValue documentation
gobject/gparamspecs.c | 3 +++
gobject/gvalue.c | 10 +++++++++-
2 files changed, 12 insertions(+), 1 deletion(-)
---
diff --git a/gobject/gparamspecs.c b/gobject/gparamspecs.c
index 8ca4b620f..d4ad8c21a 100644
--- a/gobject/gparamspecs.c
+++ b/gobject/gparamspecs.c
@@ -52,6 +52,9 @@
* Parameter names need to start with a letter (a-z or A-Z). Subsequent
* characters can be letters, numbers or a '-'.
* All other characters are replaced by a '-' during construction.
+ *
+ * See also #GValue for more information.
+ *
*/
diff --git a/gobject/gvalue.c b/gobject/gvalue.c
index 9c6c90d4d..c7b8d6485 100644
--- a/gobject/gvalue.c
+++ b/gobject/gvalue.c
@@ -44,9 +44,13 @@
* of a type identifier and a specific value of that type.
* The type identifier within a #GValue structure always determines the
* type of the associated value.
+ *
* To create an undefined #GValue structure, simply create a zero-filled
* #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
* by the #GTypeValueTable associated with the type ID stored in the #GValue.
* Other #GValue operations (such as converting values between types) are
@@ -109,6 +113,10 @@
* return 0;
* }
* ]|
+ *
+ * See also [gobject-Standard-Parameter-and-Value-Types] for more information on
+ * validation of #GValue.
+ *
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]