summaryrefslogtreecommitdiffstats
path: root/gst/audiofx/audioamplify.c
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sf.net>2009-01-28 12:29:42 +0200
committerStefan Kost <ensonic@users.sf.net>2009-01-28 12:32:59 +0200
commita99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch)
tree4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/audiofx/audioamplify.c
parent00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (diff)
Update and add documentation for plugins with no deps (gst).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered.
Diffstat (limited to 'gst/audiofx/audioamplify.c')
-rw-r--r--gst/audiofx/audioamplify.c9
1 files changed, 3 insertions, 6 deletions
diff --git a/gst/audiofx/audioamplify.c b/gst/audiofx/audioamplify.c
index ce4a0042..da5412a4 100644
--- a/gst/audiofx/audioamplify.c
+++ b/gst/audiofx/audioamplify.c
@@ -21,19 +21,16 @@
/**
* SECTION:element-audioamplify
- * @short_description: Amplifies an audio stream with selectable clipping mode
*
- * <refsect2>
* Amplifies an audio stream by a given factor and allows the selection of different clipping modes.
* The difference between the clipping modes is best evaluated by testing.
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * <refsect2>
+ * |[
* gst-launch audiotestsrc wave=saw ! audioamplify amplification=1.5 ! alsasink
* gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audioamplify amplification=1.5 method=wrap-negative ! alsasink
* gst-launch audiotestsrc wave=saw ! audioconvert ! audioamplify amplification=1.5 method=wrap-positive ! audioconvert ! alsasink
- * </programlisting>
- * </para>
+ * ]|
* </refsect2>
*/