1 files changed, 27 insertions, 0 deletions
diff --git a/gst/multipart/multipartmux.c b/gst/multipart/multipartmux.c
index 74ee8688..8bcad113 100644
--- a/gst/multipart/multipartmux.c
+++ b/gst/multipart/multipartmux.c
@@ -17,6 +17,28 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-multipartmux
+ * @short_description: Muxer that takes one or several digital streams
+ * and muxes them to a single multipart stream.
+ *
+ * <refsect2>
+ * <para>
+ * MultipartMux uses the #GstCaps of the sink pad as the Content-type field for
+ * incoming buffers when muxing them to a multipart stream. Most of the time 
+ * multipart streams are sequential JPEG frames.
+ * </para>
+ * <title>Sample pipelines</title>
+ * <para>
+ * Here is a simple pipeline to mux 5 JPEG frames per second into a multipart
+ * stream stored to a file :
+ * <programlisting>
+ * gst-launch videotestsrc ! video/x-raw-yuv, framerate=(fraction)5/1 ! jpegenc ! multipartmux ! filesink location=/tmp/test.multipart
+ * </programlisting>
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -47,6 +69,11 @@ typedef struct
 }
 GstMultipartPad;
 
+/**
+ * GstMultipartMux:
+ *
+ * The opaque #GstMultipartMux structure.
+ */
 struct _GstMultipartMux
 {
   GstElement element;