mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-04 17:52:29 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add some more Since: markers to atomic queue docs

Browse source
This commit is contained in:
Tim-Philipp Müller 2011-02-20 16:11:27 +00:00
parent b39ccb5ac3
commit 9b076246af
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
gst/gstatomicqueue.c
View file

@ -171,6 +171,8 @@ gst_atomic_queue_new (guint initial_size)
* @queue: a #GstAtomicQueue * @queue: a #GstAtomicQueue
* *
* Increase the refcount of @queue. * Increase the refcount of @queue.
*
* Since: 0.10.33
*/ */
void void
gst_atomic_queue_ref (GstAtomicQueue * queue) gst_atomic_queue_ref (GstAtomicQueue * queue)
@ -195,6 +197,8 @@ gst_atomic_queue_free (GstAtomicQueue * queue)
* @queue: a #GstAtomicQueue * @queue: a #GstAtomicQueue
* *
* Unref @queue and free the memory when the refcount reaches 0. * Unref @queue and free the memory when the refcount reaches 0.
*
* Since: 0.10.33
*/ */
void void
gst_atomic_queue_unref (GstAtomicQueue * queue) gst_atomic_queue_unref (GstAtomicQueue * queue)
@ -212,6 +216,8 @@ gst_atomic_queue_unref (GstAtomicQueue * queue)
* Peek the head element of the queue without removing it from the queue. * Peek the head element of the queue without removing it from the queue.
* *
* Returns: the head element of @queue or NULL when the queue is empty. * Returns: the head element of @queue or NULL when the queue is empty.
*
* Since: 0.10.33
*/ */
gpointer gpointer
gst_atomic_queue_peek (GstAtomicQueue * queue) gst_atomic_queue_peek (GstAtomicQueue * queue)
@ -261,6 +267,8 @@ gst_atomic_queue_peek (GstAtomicQueue * queue)
* Get the head element of the queue. * Get the head element of the queue.
* *
* Returns: the head element of @queue or NULL when the queue is empty. * Returns: the head element of @queue or NULL when the queue is empty.
*
* Since: 0.10.33
*/ */
gpointer gpointer
gst_atomic_queue_pop (GstAtomicQueue * queue) gst_atomic_queue_pop (GstAtomicQueue * queue)
@ -326,6 +334,8 @@ gst_atomic_queue_pop (GstAtomicQueue * queue)
* @data: the data * @data: the data
* *
* Append @data to the tail of the queue. * Append @data to the tail of the queue.
*
* Since: 0.10.33
*/ */
void void
gst_atomic_queue_push (GstAtomicQueue * queue, gpointer data) gst_atomic_queue_push (GstAtomicQueue * queue, gpointer data)
@ -378,6 +388,8 @@ gst_atomic_queue_push (GstAtomicQueue * queue, gpointer data)
* Get the amount of items in the queue. * Get the amount of items in the queue.
* *
* Returns: the number of elements in the queue. * Returns: the number of elements in the queue.
*
* Since: 0.10.33
*/ */
guint guint
gst_atomic_queue_length (GstAtomicQueue * queue) gst_atomic_queue_length (GstAtomicQueue * queue)

2
gst/gstatomicqueue.h
View file

@ -32,6 +32,8 @@ G_BEGIN_DECLS
* Opaque atomic data queue. * Opaque atomic data queue.
* *
* Use the acessor functions to get the stored values. * Use the acessor functions to get the stored values.
*
* Since: 0.10.33
*/ */
typedef struct _GstAtomicQueue GstAtomicQueue; typedef struct _GstAtomicQueue GstAtomicQueue;