summaryrefslogtreecommitdiff
path: root/gio/gsimpleasyncresult.c
diff options
context:
space:
mode:
Diffstat (limited to 'gio/gsimpleasyncresult.c')
-rw-r--r--gio/gsimpleasyncresult.c61
1 files changed, 30 insertions, 31 deletions
diff --git a/gio/gsimpleasyncresult.c b/gio/gsimpleasyncresult.c
index 2166bea21..b58b2e5cd 100644
--- a/gio/gsimpleasyncresult.c
+++ b/gio/gsimpleasyncresult.c
@@ -187,7 +187,7 @@
* return;
* }
*
- * _baker_prepare_cake (self, radius, baked_cb, user_data);
+ * _baker_prepare_cake (self, radius, baked_cb, simple);
* }
*
* Cake *
@@ -299,10 +299,9 @@ g_simple_async_result_init (GSimpleAsyncResult *simple)
/**
* g_simple_async_result_new:
- * @source_object: a #GObject the asynchronous function was called with,
- * or %NULL.
- * @callback: a #GAsyncReadyCallback.
- * @user_data: user data passed to @callback.
+ * @source_object: (allow-none): a #GObject, or %NULL.
+ * @callback: (scope async): a #GAsyncReadyCallback.
+ * @user_data: (closure): user data passed to @callback.
* @source_tag: the asynchronous function.
*
* Creates a #GSimpleAsyncResult.
@@ -333,9 +332,9 @@ g_simple_async_result_new (GObject *source_object,
/**
* g_simple_async_result_new_from_error:
- * @source_object: a #GObject, or %NULL.
- * @callback: a #GAsyncReadyCallback.
- * @user_data: user data passed to @callback.
+ * @source_object: (allow-none): a #GObject, or %NULL.
+ * @callback: (scope async): a #GAsyncReadyCallback.
+ * @user_data: (closure): user data passed to @callback.
* @error: a #GError
*
* Creates a #GSimpleAsyncResult from an error condition.
@@ -361,10 +360,10 @@ g_simple_async_result_new_from_error (GObject *source_object,
}
/**
- * g_simple_async_result_new_take_error:
+ * g_simple_async_result_new_take_error: (skip)
* @source_object: (allow-none): a #GObject, or %NULL
- * @callback: a #GAsyncReadyCallback
- * @user_data: (allow-none): user data passed to @callback
+ * @callback: (scope async): a #GAsyncReadyCallback
+ * @user_data: (closure): user data passed to @callback
* @error: a #GError
*
* Creates a #GSimpleAsyncResult from an error condition, and takes over the
@@ -394,9 +393,9 @@ g_simple_async_result_new_take_error (GObject *source_object,
/**
* g_simple_async_result_new_error:
- * @source_object: a #GObject, or %NULL.
- * @callback: a #GAsyncReadyCallback.
- * @user_data: user data passed to @callback.
+ * @source_object: (allow-none): a #GObject, or %NULL.
+ * @callback: (scope async): a #GAsyncReadyCallback.
+ * @user_data: (closure): user data passed to @callback.
* @domain: a #GQuark.
* @code: an error code.
* @format: a string with format characters.
@@ -489,7 +488,7 @@ g_simple_async_result_get_source_tag (GSimpleAsyncResult *simple)
/**
* g_simple_async_result_propagate_error:
* @simple: a #GSimpleAsyncResult.
- * @dest: a location to propegate the error to.
+ * @dest: (out): a location to propagate the error to.
*
* Propagates an error from within the simple asynchronous result to
* a given destination.
@@ -513,7 +512,7 @@ g_simple_async_result_propagate_error (GSimpleAsyncResult *simple,
}
/**
- * g_simple_async_result_set_op_res_gpointer:
+ * g_simple_async_result_set_op_res_gpointer: (skip)
* @simple: a #GSimpleAsyncResult.
* @op_res: a pointer result from an asynchronous function.
* @destroy_op_res: a #GDestroyNotify function.
@@ -632,7 +631,7 @@ g_simple_async_result_set_from_error (GSimpleAsyncResult *simple,
}
/**
- * g_simple_async_result_take_error:
+ * g_simple_async_result_take_error: (skip)
* @simple: a #GSimpleAsyncResult
* @error: a #GError
*
@@ -655,7 +654,7 @@ g_simple_async_result_take_error (GSimpleAsyncResult *simple,
}
/**
- * g_simple_async_result_set_error_va:
+ * g_simple_async_result_set_error_va: (skip)
* @simple: a #GSimpleAsyncResult.
* @domain: a #GQuark (usually #G_IO_ERROR).
* @code: an error code.
@@ -683,7 +682,7 @@ g_simple_async_result_set_error_va (GSimpleAsyncResult *simple,
}
/**
- * g_simple_async_result_set_error:
+ * g_simple_async_result_set_error: (skip)
* @simple: a #GSimpleAsyncResult.
* @domain: a #GQuark (usually #G_IO_ERROR).
* @code: an error code.
@@ -851,11 +850,11 @@ run_in_thread (GIOSchedulerJob *job,
}
/**
- * g_simple_async_result_run_in_thread:
+ * g_simple_async_result_run_in_thread: (skip)
* @simple: a #GSimpleAsyncResult.
* @func: a #GSimpleAsyncThreadFunc.
* @io_priority: the io priority of the request.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
*
* Runs the asynchronous job in a separate thread and then calls
* g_simple_async_result_complete_in_idle() on @simple to return
@@ -934,8 +933,8 @@ g_simple_async_result_is_valid (GAsyncResult *result,
}
/**
- * g_simple_async_report_error_in_idle:
- * @object: a #GObject.
+ * g_simple_async_report_error_in_idle: (skip)
+ * @object: (allow-none): a #GObject, or %NULL.
* @callback: a #GAsyncReadyCallback.
* @user_data: user data passed to @callback.
* @domain: a #GQuark containing the error domain (usually #G_IO_ERROR).
@@ -959,7 +958,7 @@ g_simple_async_report_error_in_idle (GObject *object,
GSimpleAsyncResult *simple;
va_list args;
- g_return_if_fail (G_IS_OBJECT (object));
+ g_return_if_fail (!object || G_IS_OBJECT (object));
g_return_if_fail (domain != 0);
g_return_if_fail (format != NULL);
@@ -976,9 +975,9 @@ g_simple_async_report_error_in_idle (GObject *object,
/**
* g_simple_async_report_gerror_in_idle:
- * @object: a #GObject.
- * @callback: a #GAsyncReadyCallback.
- * @user_data: user data passed to @callback.
+ * @object: (allow-none): a #GObject, or %NULL
+ * @callback: (scope async): a #GAsyncReadyCallback.
+ * @user_data: (closure): user data passed to @callback.
* @error: the #GError to report
*
* Reports an error in an idle function. Similar to
@@ -993,7 +992,7 @@ g_simple_async_report_gerror_in_idle (GObject *object,
{
GSimpleAsyncResult *simple;
- g_return_if_fail (G_IS_OBJECT (object));
+ g_return_if_fail (!object || G_IS_OBJECT (object));
g_return_if_fail (error != NULL);
simple = g_simple_async_result_new_from_error (object,
@@ -1005,8 +1004,8 @@ g_simple_async_report_gerror_in_idle (GObject *object,
}
/**
- * g_simple_async_report_take_gerror_in_idle:
- * @object: a #GObject.
+ * g_simple_async_report_take_gerror_in_idle: (skip)
+ * @object: (allow-none): a #GObject, or %NULL
* @callback: a #GAsyncReadyCallback.
* @user_data: user data passed to @callback.
* @error: the #GError to report
@@ -1025,7 +1024,7 @@ g_simple_async_report_take_gerror_in_idle (GObject *object,
{
GSimpleAsyncResult *simple;
- g_return_if_fail (G_IS_OBJECT (object));
+ g_return_if_fail (!object || G_IS_OBJECT (object));
g_return_if_fail (error != NULL);
simple = g_simple_async_result_new_take_error (object,