Commit 1797c8f8 authored by Nicolas Dufresne's avatar Nicolas Dufresne
Browse files

doc: Workaround gtkdoc issue

With gtkdoc 1.22, the XML generator fails when a itemizedlist is
followed by a refsect2. Workaround the issue by wrapping the
refsect2 into para.
parent 426eb3e3
......@@ -56,6 +56,7 @@
* a cutoff frequency at a quarter of the sampling rate.
* </note>
*
* <para>
* <refsect2>
* <title>Example launch line</title>
* |[
......@@ -64,6 +65,7 @@
* gst-launch-1.0 audiotestsrc wave=white-noise ! audioconvert ! audiochebband mode=band-pass lower-frequency=1000 upper-frequency=4000 type=2 ! audioconvert ! alsasink
* ]|
* </refsect2>
* </para>
*/
#ifdef HAVE_CONFIG_H
......
......@@ -52,6 +52,7 @@
* a cutoff frequency at a quarter of the sampling rate.
* </para></note>
*
* <para>
* <refsect2>
* <title>Example launch line</title>
* |[
......@@ -60,6 +61,7 @@
* gst-launch-1.0 audiotestsrc wave=white-noise ! audioconvert ! audiocheblimit mode=low-pass cutoff=800 type=2 ! audioconvert ! alsasink
* ]|
* </refsect2>
* </para>
*/
#ifdef HAVE_CONFIG_H
......
......@@ -42,12 +42,14 @@
* </listitem>
* </itemizedlist>
*
* <para>
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch-1.0 -m filesrc location=foo.ogg ! decodebin ! audioconvert ! cutter ! autoaudiosink
* ]| Show cut messages.
* </refsect2>
* </para>
*/
#ifdef HAVE_CONFIG_H
......
......@@ -31,6 +31,7 @@
* gst-launch-1.0 filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-nbands num-bands=15 band5::gain=6.0 ! alsasink
* ]| This make the equalizer use 15 bands and raises the volume of the 5th band by 6 db.
* </refsect2>
* <para>
* <refsect2>
* <title>Example code</title>
* |[
......@@ -74,6 +75,7 @@
* ...
* ]|
* </refsect2>
* </para>
*/
#ifdef HAVE_CONFIG_H
......
......@@ -104,6 +104,7 @@
* </listitem>
* </itemizedlist>
*
* <para>
* <refsect2>
* <title>Example launch line</title>
* |[
......@@ -111,6 +112,7 @@
* gst-launch-1.0 videotestsrc ! multifilesink post-messages=true filename="frame%d"
* ]|
* </refsect2>
* </para>
*/
#ifdef HAVE_CONFIG_H
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment