[gnio] Add API docs for GInitable
- From: Alexander Larsson <alexl src gnome org>
- To: svn-commits-list gnome org
- Subject: [gnio] Add API docs for GInitable
- Date: Thu, 7 May 2009 10:54:42 -0400 (EDT)
commit 95f89fffcac559bd1202bdf790c81d506c3c4ca7
Author: Alexander Larsson <alexl redhat com>
Date: Thu May 7 16:51:29 2009 +0200
Add API docs for GInitable
---
gio/ginitable.c | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
1 files changed, 55 insertions(+), 3 deletions(-)
diff --git a/gio/ginitable.c b/gio/ginitable.c
index 5062bdd..b386f82 100644
--- a/gio/ginitable.c
+++ b/gio/ginitable.c
@@ -58,7 +58,7 @@ g_initable_get_type (void)
{
const GTypeInfo initable_info =
{
- sizeof (GInitableIface), /* class_size */
+ sizeof (GInitableIface), /* class_size */
NULL, /* base_init */
NULL, /* base_finalize */
NULL,
@@ -83,8 +83,8 @@ g_initable_get_type (void)
/**
* g_initable_init:
* @initable: a #GInitable.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError location to store the error occuring, or %NULL to
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError location to store the error occuring, or %NULL to
* ignore.
*
* Initializes the object implementing the interface. This must be
@@ -127,6 +127,23 @@ g_initable_init (GInitable *initable,
return (* iface->init) (initable, cancellable, error);
}
+/**
+ * g_initable_new:
+ * @object_type: a #GType supporting #GInitable.
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError location to store the error occuring, or %NULL to
+ * ignore.
+ * @first_property_name: the name of the first property, followed by
+ * the value, and other property value pairs, and ended by %NULL.
+ *
+ * Helper function for constructing #GInitiable object. This is
+ * similar to g_object_new() but also initializes the object
+ * and returns %NULL, setting an error on failure.
+ *
+ * Return value: a newly allocated #GObject, or %NULL on error
+ *
+ * Since: 2.22
+ **/
gpointer
g_initable_new (GType object_type,
GCancellable *cancellable,
@@ -146,6 +163,23 @@ g_initable_new (GType object_type,
return object;
}
+/**
+ * g_initable_new:
+ * @object_type: a #GType supporting #GInitable.
+ * @n_parameters: the number of parameters in @parameters
+ * @parameters: the parameters to use to construct the object
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError location to store the error occuring, or %NULL to
+ * ignore.
+ *
+ * Helper function for constructing #GInitiable object. This is
+ * similar to g_object_newv() but also initializes the object
+ * and returns %NULL, setting an error on failure.
+ *
+ * Return value: a newly allocated #GObject, or %NULL on error
+ *
+ * Since: 2.22
+ **/
gpointer
g_initable_newv (GType object_type,
guint n_parameters,
@@ -168,6 +202,24 @@ g_initable_newv (GType object_type,
return (gpointer)obj;
}
+/**
+ * g_initable_new_valist:
+ * @object_type: a #GType supporting #GInitable.
+ * @first_property_name: the name of the first property, followed by
+ * the value, and other property value pairs, and ended by %NULL.
+ * @var_args: The var args list generated from @first_property_name.
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @error: a #GError location to store the error occuring, or %NULL to
+ * ignore.
+ *
+ * Helper function for constructing #GInitiable object. This is
+ * similar to g_object_new_valist() but also initializes the object
+ * and returns %NULL, setting an error on failure.
+ *
+ * Return value: a newly allocated #GObject, or %NULL on error
+ *
+ * Since: 2.22
+ **/
GObject*
g_initable_new_valist (GType object_type,
const gchar *first_property_name,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]