diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 17:46:06 +0200 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2009-01-28 18:05:09 +0200 |
| commit | 9cf73bdd8f18505269fa4b6d1d80127945e735b1 (patch) | |
| tree | 799b0f7efa6d37844173fbd636bc58254cbccd78 /ext/speex | |
| parent | 1f32369451bd5ddf7a59defef7900d508ee144da (diff) | |
Update and add documentation for plugins with deps (ext).
Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. Fix warnings that gtk-doc points out.
Diffstat (limited to 'ext/speex')
| -rw-r--r-- | ext/speex/gstspeexdec.c | 14 | ||||
| -rw-r--r-- | ext/speex/gstspeexenc.c | 16 |
2 files changed, 21 insertions, 9 deletions
diff --git a/ext/speex/gstspeexdec.c b/ext/speex/gstspeexdec.c index 0987d865..b70c45c6 100644 --- a/ext/speex/gstspeexdec.c +++ b/ext/speex/gstspeexdec.c @@ -20,23 +20,19 @@ /** * SECTION:element-speexdec - * @short_description: a decoder that decodes Speex to raw audio * @see_also: speexenc, oggdemux * - * <refsect2> - * <para> * This element decodes a Speex stream to raw integer audio. * <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free * audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org * Foundation</ulink>. - * </para> + * + * <refsect2> * <title>Example pipelines</title> - * <para> - * <programlisting> + * |[ * gst-launch -v filesrc location=speex.ogg ! oggdemux ! speexdec ! audioconvert ! audioresample ! alsasink - * </programlisting> - * Decode an Ogg/Speex file. To create an Ogg/Speex file refer to the documentation of speexenc. - * </para> + * ]| Decode an Ogg/Speex file. To create an Ogg/Speex file refer to the + * documentation of speexenc. * </refsect2> * * Last reviewed on 2006-04-05 (0.10.2) diff --git a/ext/speex/gstspeexenc.c b/ext/speex/gstspeexenc.c index 963d5607..631d90b9 100644 --- a/ext/speex/gstspeexenc.c +++ b/ext/speex/gstspeexenc.c @@ -17,6 +17,22 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-speexenc + * @see_also: speexdec, oggmux + * + * This element encodes audio as a Speex stream. + * <ulink url="http://www.speex.org/">Speex</ulink> is a royalty-free + * audio codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org + * Foundation</ulink>. + * + * <refsect2> + * <title>Example pipelines</title> + * |[ + * gst-launch audiotestsrc num-buffers=100 ! speexenc ! oggmux ! filesink location=beep.ogg + * ]| Encode an Ogg/Speex file. + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" |