docs: add StreamidDemux to documentation

https://bugzilla.gnome.org/show_bug.cgi?id=749873

diff --git a/plugins/elements/gststreamiddemux.c b/plugins/elements/gststreamiddemux.c
index c9d99f1..4ea2f80 100644 (file)
--- a/plugins/elements/gststreamiddemux.c
+++ b/plugins/elements/gststreamiddemux.c
@@ -23,10 +23,20 @@
  */
 
 /**
- * SECTION:element-streamid-demux
- * @see_also: #GstFunnel
+ * SECTION:element-streamiddemux
  *
- * Direct input stream to one out of N output pads by stream-id.
+ * The basic concept was started from de-funneling element which restores one
+ * serialized stream via #GstFunnel to its original state. #GstStreamidDemux
+ * classifies each stream base on stream ids.
+ *
+ * The stream id demux always takes one input and checks how many streams
+ * are contained in a stream by STREAM_START event. Likewise #GstFunnel,
+ * #GstStreamidDemux does not synchronize the different output streams.
+ *
+ * #GstStreamidDemux:active-pad provides information about which output pad
+ * is activated at the moment.
+ *
+ * @see_also: #GstFunnel, #gst_event_new_stream_start
  */
 
 #ifdef HAVE_CONFIG_H

diff --git a/plugins/elements/gststreamiddemux.h b/plugins/elements/gststreamiddemux.h
index ec5383b..e8b74a9 100644 (file)
--- a/plugins/elements/gststreamiddemux.h
+++ b/plugins/elements/gststreamiddemux.h
@@ -42,6 +42,11 @@ G_BEGIN_DECLS
 typedef struct _GstStreamidDemux GstStreamidDemux;
 typedef struct _GstStreamidDemuxClass GstStreamidDemuxClass;
 
+/**
+ * GstStreamidDemux:
+ *
+ * The opaque #GstStreamidDemux data structure.
+ */
 struct _GstStreamidDemux
 {
   GstElement element;