[glib/gvariant-utils] GVariant gtk-doc fixups



commit 3eb777b2096c896e3a8dc145739b5eb079cddf86
Author: Ryan Lortie <desrt desrt ca>
Date:   Thu Feb 11 22:19:36 2010 -0500

    GVariant gtk-doc fixups

 glib/gvariant.c |   37 ++++++++++++++++++++++++++++---------
 glib/gvariant.h |   22 +++++++++++-----------
 2 files changed, 39 insertions(+), 20 deletions(-)
---
diff --git a/glib/gvariant.c b/glib/gvariant.c
index 7211d1a..1284281 100644
--- a/glib/gvariant.c
+++ b/glib/gvariant.c
@@ -156,8 +156,8 @@
  *    now require 2 framing offsets for an extra two bytes.  14 + 2 + 11
  *    + 2 = 29 bytes to encode the entire two-item dictionary.
  *   </para>
- *  </refect3>
- *  <refect3>
+ *  </refsect3>
+ *  <refsect3>
  *   <title>Type Information Cache</title>
  *   <para>
  *    For each GVariant type that currently exists in the program a type
@@ -211,7 +211,7 @@
  *    different types of values in it and that only one type information
  *    structure is required for many different values of the same type.
  *   </para>
- *  </refect3>
+ *  </refsect3>
  *  <refsect3>
  *   <title>Buffer Management Memory</title>
  *   <para>
@@ -227,7 +227,7 @@
  *    serialised data.  The size of the buffer management structure is 4
  *    * (void *).  On 32bit systems, that's 16 bytes.
  *   </para>
- *  </refect3>
+ *  </refsect3>
  *  <refsect3>
  *   <title>GVariant structure</title>
  *   <para>
@@ -252,7 +252,7 @@
  *    management structure for that serialised data is shared by the
  *    child.
  *   </para>
- *  </refect3>
+ *  </refsect3>
  *  <refsect3>
  *   <title>Summary</title>
  *   <para>
@@ -589,7 +589,7 @@ g_variant_get_type_string (GVariant *value)
 /**
  * g_variant_is_of_type:
  * @value: a #GVariant instance
- * @pattern: a #GVariantType
+ * @type: a #GVariantType
  * @returns: %TRUE if the type of @value matches @type
  *
  * Checks if a value has a type matching the provided type.
@@ -713,7 +713,7 @@ g_variant_new_string (const gchar *string)
 
 /**
  * g_variant_new_object_path:
- * @string: a normal C nul-terminated string
+ * @object_path: a normal C nul-terminated string
  * @returns: a new object path #GVariant instance
  *
  * Creates a DBus object path #GVariant with the contents of @string.
@@ -754,7 +754,7 @@ g_variant_is_object_path (const gchar *string)
 
 /**
  * g_variant_new_signature:
- * @string: a normal C nul-terminated string
+ * @signature: a normal C nul-terminated string
  * @returns: a new signature #GVariant instance
  *
  * Creates a DBus type signature #GVariant with the contents of
@@ -1152,7 +1152,26 @@ g_variant_get_fixed_array (GVariant *value,
  **/
 /**
  * GVariantClass:
- *
+ * @G_VARIANT_CLASS_BOOLEAN: The #GVariant is a boolean.
+ * @G_VARIANT_CLASS_BYTE: The #GVariant is a byte.
+ * @G_VARIANT_CLASS_INT16: The #GVariant is a signed 16 bit integer.
+ * @G_VARIANT_CLASS_UINT16: The #GVariant is an unsigned 16 bit integer.
+ * @G_VARIANT_CLASS_INT32: The #GVariant is a signed 32 bit integer.
+ * @G_VARIANT_CLASS_UINT32: The #GVariant is an unsigned 32 bit integer.
+ * @G_VARIANT_CLASS_INT64: The #GVariant is a signed 64 bit integer.
+ * @G_VARIANT_CLASS_UINT64: The #GVariant is an unsigned 64 bit integer.
+ * @G_VARIANT_CLASS_HANDLE: The #GVariant is a file handle index.
+ * @G_VARIANT_CLASS_DOUBLE: The #GVariant is a double precision floating 
+ *                          point value.
+ * @G_VARIANT_CLASS_STRING: The #GVariant is a normal string.
+ * @G_VARIANT_CLASS_OBJECT_PATH: The #GVariant is a DBus object path 
+ *                               string.
+ * @G_VARIANT_CLASS_SIGNATURE: The #GVariant is a DBus signature string.
+ * @G_VARIANT_CLASS_VARIANT: The #GVariant is a variant.
+ * @G_VARIANT_CLASS_MAYBE: The #GVariant is a maybe-typed value.
+ * @G_VARIANT_CLASS_ARRAY: The #GVariant is an array.
+ * @G_VARIANT_CLASS_TUPLE: The #GVariant is a tuple.
+ * @G_VARIANT_CLASS_DICT_ENTRY: The #GVariant is a dictionary entry.
  *
  * The range of possible top-level types of #GVariant instances.
  **/
diff --git a/glib/gvariant.h b/glib/gvariant.h
index 19da9cb..1860bc2 100644
--- a/glib/gvariant.h
+++ b/glib/gvariant.h
@@ -63,16 +63,16 @@ gboolean                        g_variant_is_of_type                    (GVarian
 gboolean                        g_variant_is_container                  (GVariant             *value);
 GVariantClass                   g_variant_classify                      (GVariant             *value);
 
-GVariant *                      g_variant_new_boolean                   (gboolean              value);
-GVariant *                      g_variant_new_byte                      (guchar                value);
-GVariant *                      g_variant_new_int16                     (gint16                value);
-GVariant *                      g_variant_new_uint16                    (guint16               value);
-GVariant *                      g_variant_new_int32                     (gint32                value);
-GVariant *                      g_variant_new_uint32                    (guint32               value);
-GVariant *                      g_variant_new_int64                     (gint64                value);
-GVariant *                      g_variant_new_uint64                    (guint64               value);
-GVariant *                      g_variant_new_handle                    (gint32                value);
-GVariant *                      g_variant_new_double                    (gdouble               value);
+GVariant *                      g_variant_new_boolean                   (gboolean              boolean);
+GVariant *                      g_variant_new_byte                      (guchar                byte);
+GVariant *                      g_variant_new_int16                     (gint16                int16);
+GVariant *                      g_variant_new_uint16                    (guint16               uint16);
+GVariant *                      g_variant_new_int32                     (gint32                int32);
+GVariant *                      g_variant_new_uint32                    (guint32               uint32);
+GVariant *                      g_variant_new_int64                     (gint64                int64);
+GVariant *                      g_variant_new_uint64                    (guint64               uint64);
+GVariant *                      g_variant_new_handle                    (gint32                handle);
+GVariant *                      g_variant_new_double                    (gdouble               floating);
 GVariant *                      g_variant_new_string                    (const gchar          *string);
 GVariant *                      g_variant_new_object_path               (const gchar          *object_path);
 gboolean                        g_variant_is_object_path                (const gchar          *string);
@@ -115,7 +115,7 @@ GVariant *                      g_variant_new_dict_entry                (GVarian
 GVariant *                      g_variant_get_maybe                     (GVariant             *value);
 gsize                           g_variant_n_children                    (GVariant             *value);
 GVariant *                      g_variant_get_child_value               (GVariant             *value,
-                                                                         gsize                 index);
+                                                                         gsize                 index_);
 gconstpointer                   g_variant_get_fixed_array               (GVariant             *value,
                                                                          gsize                *n_elements,
                                                                          gsize                 element_size);



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]