Add GI annotations to GParamSpec
authorPavel Holejsovsky <pholejs@src.gnome.org>
Wed, 22 Dec 2010 21:09:21 +0000 (22:09 +0100)
committerPavel Holejsovsky <pholejs@src.gnome.org>
Mon, 27 Dec 2010 21:08:07 +0000 (22:08 +0100)
gobject/gparam.c
gobject/gparamspecs.c

index b8ba5bb..bca47d2 100644 (file)
@@ -187,7 +187,7 @@ g_param_spec_finalize (GParamSpec *pspec)
 }
 
 /**
- * g_param_spec_ref:
+ * g_param_spec_ref: (skip)
  * @pspec: a valid #GParamSpec
  *
  * Increments the reference count of @pspec.
@@ -206,7 +206,7 @@ g_param_spec_ref (GParamSpec *pspec)
 }
 
 /**
- * g_param_spec_unref:
+ * g_param_spec_unref: (skip)
  * @pspec: a valid #GParamSpec
  *
  * Decrements the reference count of a @pspec.
@@ -255,7 +255,7 @@ g_param_spec_sink (GParamSpec *pspec)
 }
 
 /**
- * g_param_spec_ref_sink:
+ * g_param_spec_ref_sink: (skip)
  * @pspec: a valid #GParamSpec
  *
  * Convenience function to ref and sink a #GParamSpec.
@@ -381,7 +381,7 @@ is_canonical (const gchar *key)
 }
 
 /**
- * g_param_spec_internal:
+ * g_param_spec_internal: (skip)
  * @param_type: the #GType for the property; must be derived from #G_TYPE_PARAM
  * @name: the canonical name of the property
  * @nick: the nickname of the property
@@ -459,7 +459,7 @@ g_param_spec_internal (GType        param_type,
  *
  * Gets back user data pointers stored via g_param_spec_set_qdata().
  *
- * Returns: the user data pointer set, or %NULL
+ * Returns: (transfer none): the user data pointer set, or %NULL
  */
 gpointer
 g_param_spec_get_qdata (GParamSpec *pspec,
@@ -495,7 +495,7 @@ g_param_spec_set_qdata (GParamSpec *pspec,
 }
 
 /**
- * g_param_spec_set_qdata_full:
+ * g_param_spec_set_qdata_full: (skip)
  * @pspec: the #GParamSpec to set store a user data pointer
  * @quark: a #GQuark, naming the user data pointer
  * @data: an opaque user data pointer
@@ -530,7 +530,7 @@ g_param_spec_set_qdata_full (GParamSpec    *pspec,
  * function (if any was set).  Usually, calling this function is only
  * required to update user data pointers with a destroy notifier.
  *
- * Returns: the user data pointer set, or %NULL
+ * Returns: (transfer none): the user data pointer set, or %NULL
  */
 gpointer
 g_param_spec_steal_qdata (GParamSpec *pspec,
@@ -556,8 +556,8 @@ g_param_spec_steal_qdata (GParamSpec *pspec,
  *
  * Since: 2.4
  *
- * Returns: paramspec to which requests on this paramspec should
- *          be redirected, or %NULL if none.
+ * Returns: (transfer none): paramspec to which requests on this
+ *          paramspec should be redirected, or %NULL if none.
  */
 GParamSpec*
 g_param_spec_get_redirect_target (GParamSpec *pspec)
@@ -887,7 +887,7 @@ param_spec_pool_equals (gconstpointer key_spec_1,
  * property name, like "GtkContainer:border-width". This feature is
  * deprecated, so you should always set @type_prefixing to %FALSE.
  *
- * Returns: a newly allocated #GParamSpecPool.
+ * Returns: (transfer none): a newly allocated #GParamSpecPool.
  */
 GParamSpecPool*
 g_param_spec_pool_new (gboolean type_prefixing)
@@ -1030,7 +1030,8 @@ param_spec_ht_lookup (GHashTable  *hash_table,
  *
  * Looks up a #GParamSpec in the pool.
  *
- * Returns: The found #GParamSpec, or %NULL if no matching #GParamSpec was found.
+ * Returns: (transfer none): The found #GParamSpec, or %NULL if no
+ * matching #GParamSpec was found.
  */
 GParamSpec*
 g_param_spec_pool_lookup (GParamSpecPool *pool,
@@ -1117,8 +1118,9 @@ pool_list (gpointer key,
  * Gets an #GList of all #GParamSpec<!-- -->s owned by @owner_type in
  * the pool.
  *
- * Returns: a #GList of all #GParamSpec<!-- -->s owned by @owner_type
- *          in the pool#GParamSpec<!-- -->s.
+ * Returns: (transfer container) (element-type GObject.ParamSpec): a
+ *          #GList of all #GParamSpec<!-- -->s owned by @owner_type in
+ *          the pool#GParamSpec<!-- -->s.
  */
 GList*
 g_param_spec_pool_list_owned (GParamSpecPool *pool,
@@ -1253,13 +1255,14 @@ pool_depth_list_for_interface (gpointer key,
  * g_param_spec_pool_list:
  * @pool: a #GParamSpecPool
  * @owner_type: the owner to look for
- * @n_pspecs_p: return location for the length of the returned array
+ * @n_pspecs_p: (out): return location for the length of the returned array
  *
  * Gets an array of all #GParamSpec<!-- -->s owned by @owner_type in
  * the pool.
  *
- * Returns: a newly allocated array containing pointers to all
- *          #GParamSpec<!-- -->s owned by @owner_type in the pool
+ * Returns: (array length=n_pspecs_p) (transfer container): a newly
+ *          allocated array containing pointers to all #GParamSpecs
+ *          owned by @owner_type in the pool
  */
 GParamSpec**
 g_param_spec_pool_list (GParamSpecPool *pool,
@@ -1429,7 +1432,7 @@ g_value_set_param (GValue     *value,
 }
 
 /**
- * g_value_set_param_take_ownership:
+ * g_value_set_param_take_ownership: (skip)
  * @value: a valid #GValue of type %G_TYPE_PARAM
  * @param: the #GParamSpec to be set
  *
@@ -1445,7 +1448,7 @@ g_value_set_param_take_ownership (GValue     *value,
 }
 
 /**
- * g_value_take_param:
+ * g_value_take_param: (skip)
  * @value: a valid #GValue of type %G_TYPE_PARAM
  * @param: the #GParamSpec to be set
  *
index 9e07cfe..f49936b 100644 (file)
@@ -1591,7 +1591,7 @@ g_param_spec_types_init (void)
 /* --- GParamSpec initialization --- */
 
 /**
- * g_param_spec_char:
+ * g_param_spec_char: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1631,7 +1631,7 @@ g_param_spec_char (const gchar *name,
 }
 
 /**
- * g_param_spec_uchar:
+ * g_param_spec_uchar: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1671,7 +1671,7 @@ g_param_spec_uchar (const gchar *name,
 }
 
 /**
- * g_param_spec_boolean:
+ * g_param_spec_boolean: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1708,7 +1708,7 @@ g_param_spec_boolean (const gchar *name,
 }
 
 /**
- * g_param_spec_int:
+ * g_param_spec_int: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1750,7 +1750,7 @@ g_param_spec_int (const gchar *name,
 }
 
 /**
- * g_param_spec_uint:
+ * g_param_spec_uint: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1792,7 +1792,7 @@ g_param_spec_uint (const gchar *name,
 }
 
 /**
- * g_param_spec_long:
+ * g_param_spec_long: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1834,7 +1834,7 @@ g_param_spec_long (const gchar *name,
 }
 
 /**
- * g_param_spec_ulong:
+ * g_param_spec_ulong: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1877,7 +1877,7 @@ g_param_spec_ulong (const gchar *name,
 }
 
 /**
- * g_param_spec_int64:
+ * g_param_spec_int64: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1919,7 +1919,7 @@ g_param_spec_int64 (const gchar *name,
 }
 
 /**
- * g_param_spec_uint64:
+ * g_param_spec_uint64: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1962,7 +1962,7 @@ g_param_spec_uint64 (const gchar *name,
 }
 
 /**
- * g_param_spec_unichar:
+ * g_param_spec_unichar: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -1998,7 +1998,7 @@ g_param_spec_unichar (const gchar *name,
 }
 
 /**
- * g_param_spec_enum:
+ * g_param_spec_enum: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2044,7 +2044,7 @@ g_param_spec_enum (const gchar *name,
 }
 
 /**
- * g_param_spec_flags:
+ * g_param_spec_flags: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2090,7 +2090,7 @@ g_param_spec_flags (const gchar *name,
 }
 
 /**
- * g_param_spec_float:
+ * g_param_spec_float: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2132,7 +2132,7 @@ g_param_spec_float (const gchar *name,
 }
 
 /**
- * g_param_spec_double:
+ * g_param_spec_double: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2175,7 +2175,7 @@ g_param_spec_double (const gchar *name,
 }
 
 /**
- * g_param_spec_string:
+ * g_param_spec_string: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2207,7 +2207,7 @@ g_param_spec_string (const gchar *name,
 }
 
 /**
- * g_param_spec_param:
+ * g_param_spec_param: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2243,7 +2243,7 @@ g_param_spec_param (const gchar *name,
 }
 
 /**
- * g_param_spec_boxed:
+ * g_param_spec_boxed: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2280,7 +2280,7 @@ g_param_spec_boxed (const gchar *name,
 }
 
 /**
- * g_param_spec_pointer:
+ * g_param_spec_pointer: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2309,7 +2309,7 @@ g_param_spec_pointer (const gchar *name,
 }
 
 /**
- * g_param_spec_gtype:
+ * g_param_spec_gtype: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2347,7 +2347,7 @@ g_param_spec_gtype (const gchar *name,
 }
 
 /**
- * g_param_spec_value_array:
+ * g_param_spec_value_array: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2391,7 +2391,7 @@ g_param_spec_value_array (const gchar *name,
 }
 
 /**
- * g_param_spec_object:
+ * g_param_spec_object: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified
@@ -2427,7 +2427,7 @@ g_param_spec_object (const gchar *name,
 }
 
 /**
- * g_param_spec_override:
+ * g_param_spec_override: (skip)
  * @name: the name of the property.
  * @overridden: The property that is being overridden
  *
@@ -2470,7 +2470,7 @@ g_param_spec_override (const gchar *name,
 }
 
 /**
- * g_param_spec_variant:
+ * g_param_spec_variant: (skip)
  * @name: canonical name of the property specified
  * @nick: nick name for the property specified
  * @blurb: description of the property specified