From 9cf73bdd8f18505269fa4b6d1d80127945e735b1 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 28 Jan 2009 17:46:06 +0200 Subject: 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. --- ext/wavpack/gstwavpackdec.c | 10 ++++------ ext/wavpack/gstwavpackenc.c | 24 ++++++++---------------- ext/wavpack/gstwavpackparse.c | 10 ++++------ 3 files changed, 16 insertions(+), 28 deletions(-) (limited to 'ext/wavpack') diff --git a/ext/wavpack/gstwavpackdec.c b/ext/wavpack/gstwavpackdec.c index 70c80f0b..41000273 100644 --- a/ext/wavpack/gstwavpackdec.c +++ b/ext/wavpack/gstwavpackdec.c @@ -24,19 +24,17 @@ /** * SECTION:element-wavpackdec * - * * WavpackDec decodes framed (for example by the WavpackParse element) * Wavpack streams and decodes them to raw audio. * Wavpack is an open-source * audio codec that features both lossless and lossy encoding. + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! audioconvert ! audioresample ! autoaudiosink - * - * This pipeline decodes the Wavpack file test.wv into raw audio buffers and + * ]| This pipeline decodes the Wavpack file test.wv into raw audio buffers and * tries to play it back using an automatically found audio sink. - * * */ diff --git a/ext/wavpack/gstwavpackenc.c b/ext/wavpack/gstwavpackenc.c index 80337647..647800c5 100644 --- a/ext/wavpack/gstwavpackenc.c +++ b/ext/wavpack/gstwavpackenc.c @@ -22,32 +22,24 @@ /** * SECTION:element-wavpackenc * - * * WavpackEnc encodes raw audio into a framed Wavpack stream. * Wavpack is an open-source * audio codec that features both lossless and lossy encoding. + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc num-buffers=500 ! audioconvert ! wavpackenc ! filesink location=sinewave.wv - * - * This pipeline encodes audio from audiotestsrc into a Wavpack file. The audioconvert element is needed + * ]| This pipeline encodes audio from audiotestsrc into a Wavpack file. The audioconvert element is needed * as the Wavpack encoder only accepts input with 32 bit width (and every depth between 1 and 32 bits). - * - * - * + * |[ * gst-launch cdda://1 ! audioconvert ! wavpackenc ! filesink location=track1.wv - * - * This pipeline encodes audio from an audio CD into a Wavpack file using + * ]| This pipeline encodes audio from an audio CD into a Wavpack file using * lossless encoding (the file output will be fairly large). - * - * - * + * |[ * gst-launch cdda://1 ! audioconvert ! wavpackenc bitrate=128000 ! filesink location=track1.wv - * - * This pipeline encodes audio from an audio CD into a Wavpack file using + * ]| This pipeline encodes audio from an audio CD into a Wavpack file using * lossy encoding at a certain bitrate (the file will be fairly small). - * * */ diff --git a/ext/wavpack/gstwavpackparse.c b/ext/wavpack/gstwavpackparse.c index 3f85205d..8fea90b0 100644 --- a/ext/wavpack/gstwavpackparse.c +++ b/ext/wavpack/gstwavpackparse.c @@ -24,19 +24,17 @@ /** * SECTION:element-wavpackparse * - * * WavpackParse takes raw, unframed Wavpack streams and splits them into * single Wavpack chunks with information like bit depth and the position * in the stream. * Wavpack is an open-source * audio codec that features both lossless and lossy encoding. + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=test.wv ! wavpackparse ! wavpackdec ! fakesink - * - * This pipeline decodes the Wavpack file test.wv into raw audio buffers. - * + * ]| This pipeline decodes the Wavpack file test.wv into raw audio buffers. * */ -- cgit