GstTask: improve documentation

Improve the documentation for the callbacks.

diff --git a/gst/gstpad.c b/gst/gstpad.c
index 0bce61d..09b0dc6 100644 (file)
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -4844,10 +4844,8 @@ pad_leave_thread (GstTask * task, GThread * thread, gpointer user_data)
 }
 
 static GstTaskThreadCallbacks thr_callbacks = {
-  NULL,
   pad_enter_thread,
   pad_leave_thread,
-  NULL
 };
 
 /**

diff --git a/gst/gsttask.c b/gst/gsttask.c
index 5ef1c57..94bda1b 100644 (file)
--- a/gst/gsttask.c
+++ b/gst/gsttask.c
@@ -334,7 +334,7 @@ is_running:
 }
 
 /**
- * gst_task_thread_callbacks:
+ * gst_task_set_thread_callbacks:
  * @task: The #GstTask to use
  * @callbacks: a #GstTaskThreadCallbacks pointer
  * @user_data: user data passed to the callbacks
@@ -344,7 +344,9 @@ is_running:
  * function is entered and left and when the thread is joined.
  *
  * By default a thread for @task will be created from a default thread pool.
- * Elements can use custom GThreads for the task by installing callbacks.
+ *
+ * Objects can use custom GThreads or can perform additional configuration of
+ * the threads (such as changing the thread priority) by installing callbacks.
  *
  * Since: 0.10.24
  *

diff --git a/gst/gsttask.h b/gst/gsttask.h
index c044c1b..2669693 100644 (file)
--- a/gst/gsttask.h
+++ b/gst/gsttask.h
@@ -115,7 +115,7 @@ typedef enum {
  * @leave_thread: a thread is exiting, this is called when the thread is about
  *   to leave its function
  *
- * Custom GstTask thread callback functions that can be installed.
+ * Custom GstTask thread callback functions that can be installed. 
  *
  * Since: 0.10.24
  */