luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-04 18:26:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Some doc additions

Browse Source 
svn path=/trunk/; revision=6358
This commit is contained in:
Matthias Clasen 2008-01-23 05:46:43 +00:00
parent 60556de1b7
commit 3bb0a17bd5
2 changed files with 35 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
gio/ChangeLog
View File

@ -1,3 +1,7 @@
2008-01-23 Matthias Clasen <mclasen@redhat.com>
* gioscheduler.c: Some documentation additions.
2008-01-22 Alexander Larsson <alexl@redhat.com> 2008-01-22 Alexander Larsson <alexl@redhat.com>
* gdesktopappinfo.c: * gdesktopappinfo.c:

38
gio/gioscheduler.c
View File

@ -196,14 +196,20 @@ run_job_at_idle (gpointer data)
/** /**
* g_io_scheduler_push_job: * g_io_scheduler_push_job:
* @job_func: a #GIOSchedulerJobFunc. * @job_func: a #GIOSchedulerJobFunc.
* @user_data: a #gpointer. * @user_data: data to pass to @job_func
* @notify: a #GDestroyNotify. * @notify: a #GDestroyNotify for @user_data, or %NULL
* @io_priority: the <link linkend="gioscheduler">I/O priority</link> * @io_priority: the <link linkend="gioscheduler">I/O priority</link>
* of the request. * of the request.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* *
* Schedules the I/O Job to run * Schedules the I/O job to run.
* *
* @notify will be called on @user_data after @job_func has returned,
* regardless whether the job was cancelled or has run to completion.
*
* If @cancellable is not %NULL, it can be used to cancel the I/O job
* by calling g_cancellable_cancel() or by calling
* g_io_scheduler_cancel_all_jobs().
**/ **/
void void
g_io_scheduler_push_job (GIOSchedulerJobFunc job_func, g_io_scheduler_push_job (GIOSchedulerJobFunc job_func,
@ -250,7 +256,10 @@ g_io_scheduler_push_job (GIOSchedulerJobFunc job_func,
/** /**
* g_io_scheduler_cancel_all_jobs: * g_io_scheduler_cancel_all_jobs:
* *
* Cancels all cancellable I/O Jobs. * Cancels all cancellable I/O jobs.
*
* A job is cancellable if a #GCancellable was passed into
* g_io_scheduler_push_job().
**/ **/
void void
g_io_scheduler_cancel_all_jobs (void) g_io_scheduler_cancel_all_jobs (void)
@ -321,10 +330,10 @@ mainloop_proxy_free (MainLoopProxy *proxy)
/** /**
* g_io_scheduler_job_send_to_mainloop: * g_io_scheduler_job_send_to_mainloop:
* @job: a #GIOSchedulerJob. * @job: a #GIOSchedulerJob
* @func: a #GSourceFunc callback that will be called in the main thread. * @func: a #GSourceFunc callback that will be called in the main thread
* @user_data: a #gpointer. * @user_data: data to pass to @func
* @notify: a #GDestroyNotify. * @notify: a #GDestroyNotify for @user_data, or %NULL
* *
* Used from an I/O job to send a callback to be run in the * Used from an I/O job to send a callback to be run in the
* main loop (main thread), waiting for the result (and thus * main loop (main thread), waiting for the result (and thus
@ -384,15 +393,20 @@ g_io_scheduler_job_send_to_mainloop (GIOSchedulerJob *job,
/** /**
* g_io_scheduler_job_send_to_mainloop_async: * g_io_scheduler_job_send_to_mainloop_async:
* @job: a #GIOSchedulerJob. * @job: a #GIOSchedulerJob
* @func: a #GSourceFunc callback that will be called in the main thread. * @func: a #GSourceFunc callback that will be called in the main thread
* @user_data: a #gpointer. * @user_data: data to pass to @func
* @notify: a #GDestroyNotify. * @notify: a #GDestroyNotify for @user_data, or %NULL
* *
* Used from an I/O job to send a callback to be run asynchronously * Used from an I/O job to send a callback to be run asynchronously
* in the main loop (main thread). The callback will be run when the * in the main loop (main thread). The callback will be run when the
* main loop is available, but at that time the I/O job might have * main loop is available, but at that time the I/O job might have
* finished. The return value from the callback is ignored. * finished. The return value from the callback is ignored.
*
* Note that if you are passing the @user_data from g_io_scheduler_push_job()
* on to this function you have to ensure that it is not freed before
* @func is called, either by passing %NULL as @notify to
* g_io_scheduler_push_job() or by using refcounting for @user_data.
**/ **/
void void
g_io_scheduler_job_send_to_mainloop_async (GIOSchedulerJob *job, g_io_scheduler_job_send_to_mainloop_async (GIOSchedulerJob *job,