Document G_VALUE_NOCOPY_CONTENTS

https://bugzilla.gnome.org/show_bug.cgi?id=624943

diff --git a/gobject/gtype.h b/gobject/gtype.h
index 24970bc..549ba03 100644 (file)
--- a/gobject/gtype.h
+++ b/gobject/gtype.h
@@ -1186,7 +1186,7 @@ struct _GInterfaceInfo
  *    return g_strdup_printf ("object location passed as NULL");
  *  if (!value->data[0].v_pointer)
  *    *object_p = NULL;
- *  else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) // always honour
+ *  else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) /* always honour */
  *    *object_p = value->data[0].v_pointer;
  *  else
  *    *object_p = g_object_ref (value->data[0].v_pointer);

diff --git a/gobject/gvalue.h b/gobject/gvalue.h
index b3f2872..89f2ee0 100644 (file)
--- a/gobject/gvalue.h
+++ b/gobject/gvalue.h
@@ -151,7 +151,15 @@ gboolean g_value_transform         (const GValue   *src_value,
 void   g_value_register_transform_func (GType           src_type,
                                         GType           dest_type,
                                         GValueTransform transform_func);
-#define G_VALUE_NOCOPY_CONTENTS                (1 << 27)
+
+/**
+ * G_VALUE_NOCOPY_CONTENTS:
+ *
+ * If passed to G_VALUE_COLLECT(), allocated data won't be copied
+ * but used verbatim. This does not affect ref-counted types like
+ * objects. For more details, see the #GValueTable documentation.
+ */
+#define G_VALUE_NOCOPY_CONTENTS (1 << 27)
 
 
 G_END_DECLS