From 0ada8ac4157fd5428e75bba57d6df9a43e2fe21e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= <slomo@circular-chaos.org>
Date: Sun, 11 Nov 2007 13:55:27 +0000
Subject: gst/equalizer/: And continue to update docs. Also include some sample
 code for the n-band equalizer in the docs.

Original commit message from CVS:
* gst/equalizer/gstiirequalizer10bands.c:
* gst/equalizer/gstiirequalizer3bands.c:
* gst/equalizer/gstiirequalizernbands.c:
And continue to update docs. Also include some sample code
for the n-band equalizer in the docs.
---
 gst/equalizer/gstiirequalizer3bands.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'gst/equalizer/gstiirequalizer3bands.c')

diff --git a/gst/equalizer/gstiirequalizer3bands.c b/gst/equalizer/gstiirequalizer3bands.c
index e2229dd7..f1e11d50 100644
--- a/gst/equalizer/gstiirequalizer3bands.c
+++ b/gst/equalizer/gstiirequalizer3bands.c
@@ -19,17 +19,19 @@
 
 /**
  * SECTION:element-equalizer-3bands
+ * @short_description: 3-band equalizer
  *
  * <refsect2>
- * <title>Example launch line</title>
  * <para>
- * The 3 band equalizer element changes the frequency spectrum of the audio data.
+ * The 3-band equalizer element allows to change the gain of a low frequency,
+ * medium frequency and high frequency band.
  * </para>
+ * <title>Example launch line</title>
  * <para>
  * <programlisting>
  * gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-3bands band1=6.0 ! alsasink
  * </programlisting>
- * This raises the volume of the 2nd band which is at 1110 Hz by 6 db.
+ * This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db.
  * </para>
  * </refsect2>
  */
-- 
cgit v1.2.1