docs: document valve element

diff --git a/plugins/elements/gstvalve.c b/plugins/elements/gstvalve.c
index 6c8c607..702b3e5 100644 (file)
--- a/plugins/elements/gstvalve.c
+++ b/plugins/elements/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/plugins/elements/gstvalve.h b/plugins/elements/gstvalve.h
index 06ab207..cc7cd38 100644 (file)
--- a/plugins/elements/gstvalve.h
+++ b/plugins/elements/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 */