From a4ed8c5d96cc8e5cdcf0e16e1b730c6a8838e993 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Olivier=20Cr=C3=AAte?= <olivier.crete@collabora.co.uk>
Date: Tue, 10 Feb 2009 18:52:54 +0000
Subject: Document the GstValve

---
 gst/valve/gstvalve.c | 12 ++++++++++++
 gst/valve/gstvalve.h |  6 ++++++
 2 files changed, 18 insertions(+)

(limited to 'gst/valve')

diff --git a/gst/valve/gstvalve.c b/gst/valve/gstvalve.c
index 6c8c6072..702b3e56 100644
--- a/gst/valve/gstvalve.c
+++ b/gst/valve/gstvalve.c
@@ -21,6 +21,18 @@
  * Boston, MA 02111-1307, USA.
  *
  */
+/**
+ * SECTION:element-valve
+ *
+ * The valve is a simple element that drops buffers when the #GstValve::drop
+ * property is set to %TRUE and lets then through otherwise.
+ *
+ * Any downstream error received while the #GstValve::drop property is %FALSE
+ * is ignored. So downstream element can be set to  %GST_STATE_NULL and removed,
+ * without using pad blocking.
+ *
+ * Last reviewed on 2008-02-10 (0.10.11)
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
diff --git a/gst/valve/gstvalve.h b/gst/valve/gstvalve.h
index 06ab2072..cc7cd385 100644
--- a/gst/valve/gstvalve.h
+++ b/gst/valve/gstvalve.h
@@ -45,8 +45,14 @@ typedef struct _GstValve GstValve;
 typedef struct _GstValveClass GstValveClass;
 typedef struct _GstValvePrivate GstValvePrivate;
 
+/**
+ * GstValve:
+ *
+ * The private valve structure
+ */
 struct _GstValve
 {
+  /*< private >*/
   GstElement parent;
 
   /* Protected by the object lock */
-- 
cgit v1.2.1