mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: fix some gtk-doc warnings

Browse source 
Document the queue leaky enums.
This commit is contained in:
Stefan Kost 2011-03-24 18:27:09 +02:00
parent 1177a968cc
commit 84eafff61b
2 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/plugins/gstreamer-plugins-sections.txt
View file

@ -149,6 +149,7 @@ GST_INPUT_SELECTOR_WAIT
<FILE>element-queue</FILE> <FILE>element-queue</FILE>
<TITLE>queue</TITLE> <TITLE>queue</TITLE>
GstQueue GstQueue
GstQueueLeaky
<SUBSECTION Standard> <SUBSECTION Standard>
GstQueueClass GstQueueClass
GST_QUEUE GST_QUEUE

25
plugins/elements/gstqueue.h
View file

@ -39,17 +39,26 @@ G_BEGIN_DECLS
#define GST_IS_QUEUE_CLASS(klass) \ #define GST_IS_QUEUE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE)) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_QUEUE))
enum { typedef struct _GstQueue GstQueue;
typedef struct _GstQueueSize GstQueueSize;
typedef enum _GstQueueLeaky GstQueueLeaky;
typedef struct _GstQueueClass GstQueueClass;
/**
* GstQueueLeaky:
* @GST_QUEUE_NO_LEAK: Not Leaky
* @GST_QUEUE_LEAK_UPSTREAM: Leaky on upstream (new buffers)
* @GST_QUEUE_LEAK_DOWNSTREAM: Leaky on downstream (old buffers)
*
* Buffer dropping scheme to avoid the queue to block when full.
*/
enum _GstQueueLeaky {
GST_QUEUE_NO_LEAK = 0, GST_QUEUE_NO_LEAK = 0,
GST_QUEUE_LEAK_UPSTREAM = 1, GST_QUEUE_LEAK_UPSTREAM = 1,
GST_QUEUE_LEAK_DOWNSTREAM = 2 GST_QUEUE_LEAK_DOWNSTREAM = 2
}; };
typedef struct _GstQueue GstQueue; /*
typedef struct _GstQueueSize GstQueueSize;
typedef struct _GstQueueClass GstQueueClass;
/**
* GstQueueSize: * GstQueueSize:
* @buffers: number of buffers * @buffers: number of buffers
* @bytes: number of bytes * @bytes: number of bytes
@ -115,8 +124,8 @@ struct _GstQueue {
gboolean head_needs_discont, tail_needs_discont; gboolean head_needs_discont, tail_needs_discont;
gboolean push_newsegment; gboolean push_newsegment;
gboolean silent; /* don't emit signals */ gboolean silent; /* don't emit signals */
/* whether the first new segment has been applied to src */ /* whether the first new segment has been applied to src */
gboolean newseg_applied_to_src; gboolean newseg_applied_to_src;