glib r6366 - trunk/gio

[matthiasc svn gnome org]

Author: matthiasc
Date: Fri Jan 25 01:44:08 2008
New Revision: 6366
URL: http://svn.gnome.org/viewvc/glib?rev=6366&view=rev

Log:
Expand docs


Modified:
   trunk/gio/ChangeLog
   trunk/gio/gioscheduler.h

Modified: trunk/gio/gioscheduler.h
==============================================================================
--- trunk/gio/gioscheduler.h	(original)
+++ trunk/gio/gioscheduler.h	Fri Jan 25 01:44:08 2008
@@ -45,12 +45,18 @@
  * @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,