qtmux: add documentation

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 2c8af15..6b0967b 100644 (file)
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -186,6 +186,7 @@ EXTRA_HFILES = \
        $(top_srcdir)/gst/mxf/mxfmux.h \
        $(top_srcdir)/gst/nuvdemux/gstnuvdemux.h \
        $(top_srcdir)/gst/pcapparse/gstpcapparse.h \
+       $(top_srcdir)/gst/qtmux/gstqtmux.h \
        $(top_srcdir)/gst/rawparse/gstaudioparse.h \
        $(top_srcdir)/gst/rawparse/gstvideoparse.h \
        $(top_srcdir)/gst/rtpmux/gstrtpmux.h \

diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index 8a9b04e..0ac3ede 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -95,6 +95,7 @@
     <xi:include href="xml/element-pcapparse.xml" />
     <xi:include href="xml/element-pinch.xml" />
     <xi:include href="xml/element-pyramidsegment.xml" />
+    <xi:include href="xml/element-qtmux.xml" />
     <xi:include href="xml/element-rtpdtmfdepay.xml" />
     <xi:include href="xml/element-rtpdtmfsrc.xml" />
     <xi:include href="xml/element-rtpdtmfmux.xml" />
@@ -194,6 +195,7 @@
     <xi:include href="xml/plugin-nsf.xml" />
     <xi:include href="xml/plugin-nuvdemux.xml" />
     <xi:include href="xml/plugin-pcapparse.xml" />
+    <xi:include href="xml/plugin-qtmux.xml" />
     <xi:include href="xml/plugin-rawparse.xml" />
     <xi:include href="xml/plugin-real.xml" />
     <xi:include href="xml/plugin-rfbsrc.xml" />

diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index e232c97..14a972f 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -1211,6 +1211,20 @@ gst_pyramidsegment_plugin_init
 </SECTION>
 
 <SECTION>
+<FILE>element-qtmux</FILE>
+<TITLE>qtmux</TITLE>
+GstQTMux
+<SUBSECTION Standard>
+GstQTMuxClass
+GST_QT_MUX
+GST_QT_MUX_CLASS
+GST_IS_QT_MUX
+GST_IS_QT_MUX_CLASS
+GST_TYPE_QT_MUX
+gst_qt_mux_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-rtpdtmfdepay</FILE>
 <TITLE>rtpdtmfdepay</TITLE>
 GstRtpDTMFDepay

diff --git a/gst/qtmux/gstqtmux.c b/gst/qtmux/gstqtmux.c
index 75594f6..5ef009a 100644 (file)
--- a/gst/qtmux/gstqtmux.c
+++ b/gst/qtmux/gstqtmux.c
@@ -43,23 +43,34 @@
 
 
 /**
- * SECTION:gstqtmux
+ * SECTION:element-qtmux
  * @short_description: Muxer for quicktime(.mov) files
  *
+ * This element merges streams (audio and video) into QuickTime(.mov) files.
+ *
+ * The following background intends to explain why various similar muxers
+ * are present in this plugin.
+ *
+ * The <ulink url="http://www.apple.com/quicktime/resources/qtfileformat.pdf">
+ * QuickTime file format specification</ulink> served as basis for the MP4 file
+ * format specification (mp4mux), and as such the QuickTime file structure is
+ * nearly identical to the so-called ISO Base Media file format defined in
+ * ISO 14496-12 (except for some media specific parts).
+ * In turn, the latter ISO Base Media format was further specialized as a
+ * Motion JPEG-2000 file format in ISO 15444-3 (mj2mux)
+ * and in various 3GPP(2) specs (gppmux).
+ * The fragmented file features defined (only) in ISO Base Media are used by
+ * ISMV files making up (a.o.) Smooth Streaming (ismlmux).
+ *
  * <refsect2>
- * <para>
- * This element merges streams (audio and video) into qt(.mov) files.
- * </para>
  * <title>Example pipelines</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch v4l2src num-buffers=500 ! video/x-raw-yuv,width=320,height=240 ! ffmpegcolorspace ! qtmux ! filesink location=video.mov
- * </programlisting>
+ * ]|
  * Records a video stream captured from a v4l2 device and muxes it into a qt file.
- * </para>
  * </refsect2>
  *
- * Last reviewed on 2008-08-27
+ * Last reviewed on 2010-12-03
  */
 
 /*