diff options
| author | Stefan Kost <ensonic@users.sourceforge.net> | 2008-02-07 13:41:11 +0000 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sourceforge.net> | 2008-02-07 13:41:11 +0000 |
| commit | fd149d267fb4028e5bf382104bdcde813348a9b3 (patch) | |
| tree | 3d81fb230853f7e3a13be69aefa864b48476bf02 | |
| parent | 120a00c2e7434d26caa9d72b7c00221d1917cf22 (diff) | |
| download | gst-plugins-bad-fd149d267fb4028e5bf382104bdcde813348a9b3.tar.gz gst-plugins-bad-fd149d267fb4028e5bf382104bdcde813348a9b3.tar.bz2 gst-plugins-bad-fd149d267fb4028e5bf382104bdcde813348a9b3.zip | |
gst/spectrum/gstspectrum.c: Improve the docs.
Original commit message from CVS:
* gst/spectrum/gstspectrum.c:
Improve the docs.
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | gst/spectrum/gstspectrum.c | 14 |
2 files changed, 12 insertions, 7 deletions
@@ -1,3 +1,8 @@ +2008-02-07 Stefan Kost <ensonic@users.sf.net> + + * gst/spectrum/gstspectrum.c: + Improve the docs. + 2008-02-07 Tim-Philipp Müller <tim at centricular dot net> * configure.ac: diff --git a/gst/spectrum/gstspectrum.c b/gst/spectrum/gstspectrum.c index b2807d41..e3f7b2d4 100644 --- a/gst/spectrum/gstspectrum.c +++ b/gst/spectrum/gstspectrum.c @@ -20,17 +20,18 @@ */ /** * SECTION:element-spectrum + * @short_description: audio spectrum analyzer * * <refsect2> * <para> * The Spectrum element analyzes the frequency spectrum of an audio signal. - * If <link linkend="GstSpectrum--message">message property</link> is #TRUE it - * sends analysis results as application message named + * If #GstSpectrum:message property is #TRUE it sends analysis results as + * application message named * <classname>"spectrum"</classname> after each interval of time given - * by the <link linkend="GstSpectrum--interval">interval property</link>. + * by the #GstSpectrum:interval property. * </para> * <para> - * The message's structure contains two fields: + * The message's structure contains three fields: * <itemizedlist> * <listitem> * <para> @@ -44,8 +45,7 @@ * #GstValueList of #gfloat * <classname>"magnitude"</classname>: * the level for each frequency band in dB. All values below the value of the - * <link linkend="GstSpectrum--threshold">threshold property</link> will - * be set to the threshold. + * #GstSpectrum:threshold property will be set to the threshold. * </para> * </listitem> * <listitem> @@ -62,7 +62,7 @@ * The included demo shows how to use it in an application. * </para> * <para> - * Last reviewed on 2007-11-11 (0.10.6) + * Last reviewed on 2008-02-07 (0.10.6) * </para> * </refsect2> */ |