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/flac | |
| 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/flac')
| -rw-r--r-- | ext/flac/gstflacdec.c | 20 | ||||
| -rw-r--r-- | ext/flac/gstflacenc.c | 15 |
2 files changed, 22 insertions, 13 deletions
diff --git a/ext/flac/gstflacdec.c b/ext/flac/gstflacdec.c index 8244e79a..dedbd617 100644 --- a/ext/flac/gstflacdec.c +++ b/ext/flac/gstflacdec.c @@ -21,26 +21,20 @@ /** * SECTION:element-flacdec - * @seealso: flacenc + * @see_also: #GstFlacEnc * - * <refsect2> - * <para> * flacdec decodes FLAC streams. * <ulink url="http://flac.sourceforge.net/">FLAC</ulink> * is a Free Lossless Audio Codec. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=media/small/dark.441-16-s.flac ! flacdec ! audioconvert ! audioresample ! autoaudiosink - * </programlisting> - * </para> - * <title>Another example launch line</title> - * <para> - * <programlisting> + * ]| + * |[ * gst-launch gnomevfssrc location=http://gstreamer.freedesktop.org/media/small/dark.441-16-s.flac ! flacdec ! audioconvert ! audioresample ! queue min-threshold-buffers=10 ! autoaudiosink - * </programlisting> - * </para> + * ]| * </refsect2> */ diff --git a/ext/flac/gstflacenc.c b/ext/flac/gstflacenc.c index e5a7804b..3fade910 100644 --- a/ext/flac/gstflacenc.c +++ b/ext/flac/gstflacenc.c @@ -16,6 +16,21 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-flacenc + * @see_also: #GstFlacDec + * + * flacenc encodes FLAC streams. + * <ulink url="http://flac.sourceforge.net/">FLAC</ulink> + * is a Free Lossless Audio Codec. + * + * <refsect2> + * <title>Example launch line</title> + * |[ + * gst-launch audiotestsrc num-buffers=100 ! flacenc ! filesink location=beep.flac + * ]| + * </refsect2> + */ /* TODO: - We currently don't handle discontinuities in the stream in a useful * way and instead rely on the developer plugging in audiorate if |