gdbus-codegen: Clean config.pyc to make distcheck happy

[platform/upstream/glib.git] / gobject / gvalue.h

diff --git a/gobject/gvalue.h b/gobject/gvalue.h
index b93e1e9..60c1919 100644 (file)
--- a/gobject/gvalue.h
+++ b/gobject/gvalue.h
@@ -30,16 +30,81 @@
 G_BEGIN_DECLS
 
 /* --- type macros --- */
+/**
+ * G_TYPE_IS_VALUE:
+ * @type: A #GType value.
+ * 
+ * Checks whether the passed in type ID can be used for g_value_init().
+ * That is, this macro checks whether this type provides an implementation
+ * of the #GTypeValueTable functions required for a type to create a #GValue of.
+ * 
+ * Returns: Whether @type is suitable as a #GValue type.
+ */
 #define        G_TYPE_IS_VALUE(type)           (g_type_check_is_value_type (type))
+/**
+ * G_IS_VALUE:
+ * @value: A #GValue structure.
+ * 
+ * Checks if @value is a valid and initialized #GValue structure.
+ *
+ * Returns: %TRUE on success.
+ */
 #define        G_IS_VALUE(value)               (G_TYPE_CHECK_VALUE (value))
+/**
+ * G_VALUE_TYPE:
+ * @value: A #GValue structure.
+ * 
+ * Get the type identifier of @value.
+ *
+ * Returns: the #GType.
+ */
 #define        G_VALUE_TYPE(value)             (((GValue*) (value))->g_type)
+/**
+ * G_VALUE_TYPE_NAME:
+ * @value: A #GValue structure.
+ *
+ * Gets the the type name of @value. 
+ *
+ * Returns: the type name.
+ */
 #define        G_VALUE_TYPE_NAME(value)        (g_type_name (G_VALUE_TYPE (value)))
+/**
+ * G_VALUE_HOLDS:
+ * @value: A #GValue structure.
+ * @type: A #GType value.
+ * 
+ * Checks if @value holds (or contains) a value of @type.
+ * This macro will also check for @value != %NULL and issue a
+ * warning if the check fails.
+ *
+ * Returns: %TRUE if @value holds the @type.
+ */
 #define G_VALUE_HOLDS(value,type)      (G_TYPE_CHECK_VALUE_TYPE ((value), (type)))
 
 
 /* --- typedefs & structures --- */
+/**
+ * GValueTransform:
+ * @src_value: Source value.
+ * @dest_value: Target value.
+ * 
+ * The type of value transformation functions which can be registered with
+ * g_value_register_transform_func().
+ */
 typedef void (*GValueTransform) (const GValue *src_value,
                                 GValue       *dest_value);
+/**
+ * GValue:
+ * 
+ * An opaque structure used to hold different types of values.
+ * The data within the structure has protected scope: it is accessible only
+ * to functions within a #GTypeValueTable structure, or implementations of
+ * the g_value_*() API. That is, code portions which implement new fundamental
+ * types.
+ * #GValue users cannot make any assumptions about how data is stored
+ * within the 2 element @data union, and the @g_type member should
+ * only be accessed through the G_VALUE_TYPE() macro.
+ */
 struct _GValue
 {
   /*< private >*/
@@ -86,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