Expand docs

svn path=/trunk/; revision=6366

diff --git a/gio/ChangeLog b/gio/ChangeLog
index 4454d97..c763c9e 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,7 @@
+2008-01-24  Matthias Clasen  <mclasen@redhat.com>
+
+       * gioscheduler.h: Expand docs a bit.
+
 2008-01-24  Alexander Larsson  <alexl@redhat.com>
 
         * gdrive.[ch]:

diff --git a/gio/gioscheduler.h b/gio/gioscheduler.h
index acc2e1e..c33cee8 100644 (file)
--- a/gio/gioscheduler.h
+++ b/gio/gioscheduler.h
@@ -45,12 +45,18 @@ typedef struct _GIOSchedulerJob GIOSchedulerJob;
  * @cancellable: optional #GCancellable object, %NULL to ignore.
  * @user_data: the data to pass to callback function
  * 
- * I/O Job function.
- * 
+ * I/O Job function. 
+ *
+ * Note that depending on whether threads are available, the 
+ * #GIOScheduler may run jobs in separate threads or in an idle 
+ * in the mainloop. 
+ *
+ * Long-running jobs should periodically check the @cancellable
+ * to see if they have been cancelled.
  **/
 typedef void (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
-                                    GCancellable *cancellable,
-                                    gpointer user_data);
+                                    GCancellable    *cancellable,
+                                    gpointer         user_data);
 
 void     g_io_scheduler_push_job                   (GIOSchedulerJobFunc  job_func,
                                                    gpointer             user_data,