summaryrefslogtreecommitdiff
path: root/gio/gsimpleasyncresult.h
diff options
context:
space:
mode:
authorAndrew Walton <awalton@src.gnome.org>2007-11-27 14:00:13 +0000
committerAndrew Walton <awalton@src.gnome.org>2007-11-27 14:00:13 +0000
commit5247f12f3649726471080440de0d37b78c1cec33 (patch)
tree69bd070ba8cb8b12234319e354f5cb856d0c551f /gio/gsimpleasyncresult.h
parent6d071b4ab6d60aecf9532d1aac2128dd0c08f917 (diff)
downloadglib-5247f12f3649726471080440de0d37b78c1cec33.tar.gz
Bumps documentation to 93% symbol coverage, touching most
of the public files. Fixes broken function documentation prototypes. Fixes GCancellable inaccuracies. Removes unnecessary incomplete gtk-doc headers in private files. svn path=/trunk/; revision=5953
Diffstat (limited to 'gio/gsimpleasyncresult.h')
-rw-r--r--gio/gsimpleasyncresult.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/gio/gsimpleasyncresult.h b/gio/gsimpleasyncresult.h
index 4c4ecf8e6..0607f8835 100644
--- a/gio/gsimpleasyncresult.h
+++ b/gio/gsimpleasyncresult.h
@@ -35,9 +35,23 @@ G_BEGIN_DECLS
#define G_IS_SIMPLE_ASYNC_RESULT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SIMPLE_ASYNC_RESULT))
#define G_SIMPLE_ASYNC_RESULT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResultClass))
+/**
+ * GSimpleAsyncResult:
+ *
+ * A simple implementation of #GAsyncResult.
+ **/
typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
typedef struct _GSimpleAsyncResultClass GSimpleAsyncResultClass;
+/**
+ * GSimpleAsyncThreadFunc:
+ * @res: a #GSimpleAsyncResult.
+ * @object: a #GObject.
+ * @cancellable: optional #GCancellable object, %NULL to ignore.
+ *
+ * Simple thread function that runs an asynchronous operation and
+ * checks for cancellation.
+ **/
typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
GObject *object,
GCancellable *cancellable);