[glib/GVariantType] GVariantType: fix copyrights, add Since: tags



commit 71f2920a5604603d12e5bd1a1be4972f9d7dfd23
Author: Ryan Lortie <desrt desrt ca>
Date:   Fri Jan 22 14:25:27 2010 -0500

    GVariantType: fix copyrights, add Since: tags

 glib/gvarianttype.c |   79 ++++++++++++++++++++++++++++++++++++++++++++------
 glib/gvarianttype.h |    4 ++-
 2 files changed, 72 insertions(+), 11 deletions(-)
---
diff --git a/glib/gvarianttype.c b/glib/gvarianttype.c
index d0ec6e7..0abb0b3 100644
--- a/glib/gvarianttype.c
+++ b/glib/gvarianttype.c
@@ -1,5 +1,6 @@
 /*
  * Copyright © 2007, 2008 Ryan Lortie
+ * Copyright © 2009, 2010 Codethink Limited
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -15,6 +16,8 @@
  * License along with this library; if not, write to the
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
+ *
+ * Author: Ryan Lortie <desrt desrt ca>
  */
 
 #include "gvarianttype.h"
@@ -477,6 +480,16 @@
  */
 
 /**
+ * GVariantType:
+ *
+ * A type in the GVariant type system.
+ *
+ * Two types may not be compared by value; use g_variant_type_equal() or
+ * g_variant_type_is_subtype().  May be copied using
+ * g_variant_type_copy() and freed using g_variant_type_free().
+ **/
+
+/**
  * G_VARIANT_TYPE:
  * @type_string: a well-formed #GVariantType type string
  *
@@ -486,17 +499,9 @@
  *
  * It is always a programmer error to use this macro with an invalid
  * type string.
- **/ 
-
-/**
- * GVariantType:
- *
- * A type in the GVariant type system.
  *
- * Two types may not be compared by value; use g_variant_type_equal() or
- * g_variant_type_is_subtype().  May be copied using
- * g_variant_type_copy() and freed using g_variant_type_free().
- **/
+ * Since 2.24
+ **/ 
 
 /**
  * g_variant_type_string_scan:
@@ -518,6 +523,8 @@
  *
  * For the simple case of checking if a string is a valid type string,
  * see g_variant_type_string_is_valid().
+ *
+ * Since: 2.24
  **/
 gboolean
 g_variant_type_string_scan (const gchar  *string,
@@ -577,6 +584,8 @@ g_variant_type_string_scan (const gchar  *string,
  * Checks if @type_string is a valid GVariant type string.  This call is
  * equivalent to calling g_variant_type_string_scan() and confirming
  * that the following character is a nul terminator.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_string_is_valid (const gchar *type_string)
@@ -596,6 +605,8 @@ g_variant_type_string_is_valid (const gchar *type_string)
  * type constructor functions.
  *
  * In the case that @type is %NULL, this function does nothing.
+ *
+ * Since 2.24
  **/
 void
 g_variant_type_free (GVariantType *type)
@@ -610,6 +621,8 @@ g_variant_type_free (GVariantType *type)
  *
  * Makes a copy of a #GVariantType.  It is appropriate to call
  * g_variant_type_free() on the return value.  @type may not be %NULL.
+ *
+ * Since 2.24
  **/
 GVariantType *
 g_variant_type_copy (const GVariantType *type)
@@ -652,6 +665,8 @@ g_variant_type_new (const gchar *type_string)
  * Returns the length of the type string corresponding to the given
  * @type.  This function must be used to determine the valid extent of
  * the memory region returned by g_variant_type_peek_string().
+ *
+ * Since 2.24
  **/
 gsize
 g_variant_type_get_string_length (const GVariantType *type)
@@ -688,6 +703,8 @@ g_variant_type_get_string_length (const GVariantType *type)
  * must call g_variant_type_get_string_length().
  *
  * To get a nul-terminated string, see g_variant_type_dup_string().
+ *
+ * Since 2.24
  **/
 const gchar *
 g_variant_type_peek_string (const GVariantType *type)
@@ -703,6 +720,8 @@ g_variant_type_peek_string (const GVariantType *type)
  * Returns a newly-allocated copy of the type string corresponding to
  * @type.  The returned string is nul-terminated.  It is appropriate to
  * call g_free() on the return value.
+ *
+ * Since 2.24
  **/
 gchar *
 g_variant_type_dup_string (const GVariantType *type)
@@ -726,6 +745,8 @@ g_variant_type_dup_string (const GVariantType *type)
  * result in %TRUE being returned.  Calling this function on an
  * indefinite type like %G_VARIANT_TYPE_ARRAY, however, will result in
  * %FALSE being returned.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_definite (const GVariantType *type)
@@ -756,6 +777,8 @@ g_variant_type_is_definite (const GVariantType *type)
  * This function returns %TRUE for any indefinite type for which every
  * definite subtype is a container -- %G_VARIANT_TYPE_ARRAY, for
  * example.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_container (const GVariantType *type)
@@ -791,6 +814,8 @@ g_variant_type_is_container (const GVariantType *type)
  *
  * This function returns %FALSE for all indefinite types except
  * %G_VARIANT_TYPE_BASIC.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_basic (const GVariantType *type)
@@ -831,6 +856,8 @@ g_variant_type_is_basic (const GVariantType *type)
  * This function returns %TRUE for any indefinite type for which every
  * definite subtype is a maybe type -- %G_VARIANT_TYPE_MAYBE, for
  * example.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_maybe (const GVariantType *type)
@@ -849,6 +876,8 @@ g_variant_type_is_maybe (const GVariantType *type)
  * This function returns %TRUE for any indefinite type for which every
  * definite subtype is an array type -- %G_VARIANT_TYPE_ARRAY, for
  * example.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_array (const GVariantType *type)
@@ -868,6 +897,8 @@ g_variant_type_is_array (const GVariantType *type)
  * This function returns %TRUE for any indefinite type for which every
  * definite subtype is a tuple type -- %G_VARIANT_TYPE_TUPLE, for
  * example.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_tuple (const GVariantType *type)
@@ -888,6 +919,8 @@ g_variant_type_is_tuple (const GVariantType *type)
  * This function returns %TRUE for any indefinite type for which every
  * definite subtype is a dictionary entry type --
  * %G_VARIANT_TYPE_DICT_ENTRY, for example.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_dict_entry (const GVariantType *type)
@@ -905,6 +938,8 @@ g_variant_type_is_dict_entry (const GVariantType *type)
  * The argument type of @type is only #gconstpointer to allow use with
  * #GHashTable without function pointer casting.  A valid
  * #GVariantType must be provided.
+ *
+ * Since 2.24
  **/
 guint
 g_variant_type_hash (gconstpointer type)
@@ -936,6 +971,8 @@ g_variant_type_hash (gconstpointer type)
  * The argument types of @type1 and @type2 are only #gconstpointer to
  * allow use with #GHashTable without function pointer casting.  For
  * both arguments, a valid #GVariantType must be provided.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_equal (gconstpointer type1,
@@ -970,6 +1007,8 @@ g_variant_type_equal (gconstpointer type1,
  * This function returns %TRUE if @type is a subtype of @supertype.  All
  * types are considered to be subtypes of themselves.  Aside from that,
  * only indefinite types can have subtypes.
+ *
+ * Since 2.24
  **/
 gboolean
 g_variant_type_is_subtype_of (const GVariantType *type,
@@ -1035,6 +1074,8 @@ g_variant_type_is_subtype_of (const GVariantType *type,
  * Determines the element type of an array or maybe type.
  *
  * This function may only be used with array or maybe types.
+ *
+ * Since 2.24
  **/
 const GVariantType *
 g_variant_type_element (const GVariantType *type)
@@ -1065,6 +1106,8 @@ g_variant_type_element (const GVariantType *type)
  *
  * This call, together with g_variant_type_next() provides an iterator
  * interface over tuple and dictionary entry types.
+ *
+ * Since 2.24
  **/
 const GVariantType *
 g_variant_type_first (const GVariantType *type)
@@ -1095,6 +1138,8 @@ g_variant_type_first (const GVariantType *type)
  * entry then this call returns %NULL.
  *
  * For tuples, %NULL is returned when @type is the last item in a tuple.
+ *
+ * Since 2.24
  **/
 const GVariantType *
 g_variant_type_next (const GVariantType *type)
@@ -1123,6 +1168,8 @@ g_variant_type_next (const GVariantType *type)
  *
  * In the case of a dictionary entry type, this function will always
  * return 2.
+ *
+ * Since 2.24
  **/
 gsize
 g_variant_type_n_items (const GVariantType *type)
@@ -1147,6 +1194,8 @@ g_variant_type_n_items (const GVariantType *type)
  * This function may only be used with a dictionary entry type.  Other
  * than the additional restriction, this call is equivalent to
  * g_variant_type_first().
+ *
+ * Since 2.24
  **/
 const GVariantType *
 g_variant_type_key (const GVariantType *type)
@@ -1166,6 +1215,8 @@ g_variant_type_key (const GVariantType *type)
  * Determines the value type of a dictionary entry type.
  *
  * This function may only be used with a dictionary entry type.
+ *
+ * Since 2.24
  **/
 const GVariantType *
 g_variant_type_value (const GVariantType *type)
@@ -1186,6 +1237,8 @@ g_variant_type_value (const GVariantType *type)
  * Constructs a new tuple type, from @items.
  *
  * It is appropriate to call g_variant_type_free() on the return value.
+ *
+ * Since 2.24
  **/
 static GVariantType *
 g_variant_type_new_tuple_slow (const GVariantType * const *items,
@@ -1262,6 +1315,8 @@ g_variant_type_new_tuple (const GVariantType * const *items,
  * type @type.
  *
  * It is appropriate to call g_variant_type_free() on the return value.
+ *
+ * Since 2.24
  **/
 GVariantType *
 g_variant_type_new_array (const GVariantType *element)
@@ -1291,6 +1346,8 @@ g_variant_type_new_array (const GVariantType *element)
  * type @type or Nothing.
  *
  * It is appropriate to call g_variant_type_free() on the return value.
+ *
+ * Since 2.24
  **/
 GVariantType *
 g_variant_type_new_maybe (const GVariantType *element)
@@ -1321,6 +1378,8 @@ g_variant_type_new_maybe (const GVariantType *element)
  * of type @key and a value of type @value.
  *
  * It is appropriate to call g_variant_type_free() on the return value.
+ *
+ * Since 2.24
  **/
 GVariantType *
 g_variant_type_new_dict_entry (const GVariantType *key,
diff --git a/glib/gvarianttype.h b/glib/gvarianttype.h
index c34e049..43e53e9 100644
--- a/glib/gvarianttype.h
+++ b/glib/gvarianttype.h
@@ -1,6 +1,6 @@
 /*
  * Copyright © 2007, 2008 Ryan Lortie
- * Copyright © 2009 Codethink Limited
+ * Copyright © 2009, 2010 Codethink Limited
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -16,6 +16,8 @@
  * License along with this library; if not, write to the
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
+ *
+ * Author: Ryan Lortie <desrt desrt ca>
  */
 
 #ifndef __G_VARIANT_TYPE_H__



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