From 57abeb56a84c1f322ba21d42ee9d948be533a21b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tim-Philipp=20M=C3=BCller?= Date: Wed, 6 Jan 2010 19:18:53 +0000 Subject: [PATCH] docs: add Since markers to task pool docs and document task function --- gst/gsttaskpool.c | 10 ++++++++++ gst/gsttaskpool.h | 8 ++++++++ 2 files changed, 18 insertions(+) diff --git a/gst/gsttaskpool.c b/gst/gsttaskpool.c index e065fca..c183ab1 100644 --- a/gst/gsttaskpool.c +++ b/gst/gsttaskpool.c @@ -156,6 +156,8 @@ gst_task_pool_finalize (GObject * object) * GThreadPool for threads. * * Returns: a new #GstTaskPool. gst_object_unref() after usage. + * + * Since: 0.10.24 */ GstTaskPool * gst_task_pool_new (void) @@ -175,6 +177,8 @@ gst_task_pool_new (void) * Prepare the taskpool for accepting gst_task_pool_push() operations. * * MT safe. + * + * Since: 0.10.24 */ void gst_task_pool_prepare (GstTaskPool * pool, GError ** error) @@ -197,6 +201,8 @@ gst_task_pool_prepare (GstTaskPool * pool, GError ** error) * to ensure proper cleanup of internal data structures in test suites. * * MT safe. + * + * Since: 0.10.24 */ void gst_task_pool_cleanup (GstTaskPool * pool) @@ -223,6 +229,8 @@ gst_task_pool_cleanup (GstTaskPool * pool) * Returns: a pointer that should be used for the gst_task_pool_join * function. This pointer can be NULL, you must check @error to detect * errors. + * + * Since: 0.10.24 */ gpointer gst_task_pool_push (GstTaskPool * pool, GstTaskPoolFunction func, @@ -254,6 +262,8 @@ not_supported: * * Join a task and/or return it to the pool. @id is the id obtained from * gst_task_pool_push(). + * + * Since: 0.10.24 */ void gst_task_pool_join (GstTaskPool * pool, gpointer id) diff --git a/gst/gsttaskpool.h b/gst/gsttaskpool.h index eda5c6c..912015e 100644 --- a/gst/gsttaskpool.h +++ b/gst/gsttaskpool.h @@ -38,6 +38,14 @@ G_BEGIN_DECLS typedef struct _GstTaskPool GstTaskPool; typedef struct _GstTaskPoolClass GstTaskPoolClass; +/** + * GstTaskPoolFunction: + * @data: user data for the task function + * + * Task function, see gst_task_pool_push(). + * + * Since: 0.10.24 + */ typedef void (*GstTaskPoolFunction) (void *data); /** -- 2.7.4