mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add Since markers to task pool docs and document task function

Browse source
This commit is contained in:
Tim-Philipp Müller 2010-01-06 19:18:53 +00:00
parent 9a4f0d8ca3
commit 57abeb56a8
2 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
gst/gsttaskpool.c
View file

@ -156,6 +156,8 @@ gst_task_pool_finalize (GObject * object)
* GThreadPool for threads. * GThreadPool for threads.
* *
* Returns: a new #GstTaskPool. gst_object_unref() after usage. * Returns: a new #GstTaskPool. gst_object_unref() after usage.
*
* Since: 0.10.24
*/ */
GstTaskPool * GstTaskPool *
gst_task_pool_new (void) gst_task_pool_new (void)
@ -175,6 +177,8 @@ gst_task_pool_new (void)
* Prepare the taskpool for accepting gst_task_pool_push() operations. * Prepare the taskpool for accepting gst_task_pool_push() operations.
* *
* MT safe. * MT safe.
*
* Since: 0.10.24
*/ */
void void
gst_task_pool_prepare (GstTaskPool * pool, GError ** error) 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. * to ensure proper cleanup of internal data structures in test suites.
* *
* MT safe. * MT safe.
*
* Since: 0.10.24
*/ */
void void
gst_task_pool_cleanup (GstTaskPool * pool) 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 * 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 * function. This pointer can be NULL, you must check @error to detect
* errors. * errors.
*
* Since: 0.10.24
*/ */
gpointer gpointer
gst_task_pool_push (GstTaskPool * pool, GstTaskPoolFunction func, 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 * Join a task and/or return it to the pool. @id is the id obtained from
* gst_task_pool_push(). * gst_task_pool_push().
*
* Since: 0.10.24
*/ */
void void
gst_task_pool_join (GstTaskPool * pool, gpointer id) gst_task_pool_join (GstTaskPool * pool, gpointer id)

8
gst/gsttaskpool.h
View file

@ -38,6 +38,14 @@ G_BEGIN_DECLS
typedef struct _GstTaskPool GstTaskPool; typedef struct _GstTaskPool GstTaskPool;
typedef struct _GstTaskPoolClass GstTaskPoolClass; 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); typedef void (*GstTaskPoolFunction) (void *data);
/** /**