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/apetag | |
| 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/apetag')
| -rw-r--r-- | gst/apetag/gstapedemux.c | 19 |
1 files changed, 6 insertions, 13 deletions
diff --git a/gst/apetag/gstapedemux.c b/gst/apetag/gstapedemux.c index 7adc2ccd..fc9c3aae 100644 --- a/gst/apetag/gstapedemux.c +++ b/gst/apetag/gstapedemux.c @@ -20,33 +20,26 @@ /** * SECTION:element-apedemux - * @short_description: reads tag information from APE tag data blocks and - * outputs them as GStreamer tag messages and events. * - * <refsect2> - * <para> * apedemux accepts data streams with APE tags at the start or at the end * (or both). The mime type of the data between the tag blocks is detected * using typefind functions, and the appropriate output mime type set on - * outgoing buffers. - * </para> - * <para> + * outgoing buffers. + * * The element is only able to read APE tags at the end of a stream from * a seekable stream, ie. when get_range mode is supported by the upstream * elements. If get_range operation is available, apedemux makes it available * downstream. This means that elements which require get_range mode, such as * wavparse or musepackdec, can operate on files containing APE tag * information. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch -t filesrc location=file.mpc ! apedemux ! fakesink - * </programlisting> - * This pipeline should read any available APE tag information and output it. + * ]| This pipeline should read any available APE tag information and output it. * The contents of the file inside the APE tag regions should be detected, and * the appropriate mime type set on buffers produced from apedemux. - * </para> * </refsect2> */ #ifdef HAVE_CONFIG_H |