diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:29:42 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 12:32:59 +0200 |
| commit | a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 (patch) | |
| tree | 4a5cf5e0f2f44b1f9ccea5344c38ef98f0a92990 /gst/spectrum | |
| parent | 00fdca0c14eb9a5fe6b8b9f2d5ce2313e3b32f23 (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/spectrum')
| -rw-r--r-- | gst/spectrum/gstspectrum.c | 24 |
1 files changed, 8 insertions, 16 deletions
diff --git a/gst/spectrum/gstspectrum.c b/gst/spectrum/gstspectrum.c index 15d3592e..63675c17 100644 --- a/gst/spectrum/gstspectrum.c +++ b/gst/spectrum/gstspectrum.c @@ -20,17 +20,13 @@ */ /** * SECTION:element-spectrum - * @short_description: audio spectrum analyzer * - * <refsect2> - * <para> * The Spectrum element analyzes the frequency spectrum of an audio signal. * If the #GstSpectrum:message property is #TRUE, it sends analysis results as * application messages named * <classname>"spectrum"</classname> after each interval of time given * by the #GstSpectrum:interval property. - * </para> - * <para> + * * The message's structure contains some combination of these fields: * <itemizedlist> * <listitem> @@ -87,19 +83,15 @@ * </para> * </listitem> * </itemizedlist> - * </para> - * <para> - * This element cannot be used with the gst-launch command in a sensible way. - * This sample code demonstrates how to use it in an application. - * </para> + * + * <refsect2> * <title>Example application</title> - * <para> - * <include xmlns="http://www.w3.org/2003/XInclude" href="element-spectrum-example.xml" /> - * </para> - * <para> - * Last reviewed on 2009-01-14 (0.10.12) - * </para> + * |[ + * <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" parse="text" href="../../../../tests/examples/spectrum/spectrum-example.c" /> + * ]| * </refsect2> + * + * Last reviewed on 2009-01-14 (0.10.12) */ #ifdef HAVE_CONFIG_H |