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/dv | |
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/dv')
-rw-r--r-- | ext/dv/gstdvdec.c | 20 | ||||
-rw-r--r-- | ext/dv/gstdvdemux.c | 22 |
2 files changed, 17 insertions, 25 deletions
diff --git a/ext/dv/gstdvdec.c b/ext/dv/gstdvdec.c index 958aa518..ade97966 100644 --- a/ext/dv/gstdvdec.c +++ b/ext/dv/gstdvdec.c @@ -21,25 +21,21 @@ /** * SECTION:element-dvdec * - * <refsect2> - * <para> * dvdec decodes DV video into raw video. The element expects a full DV frame * as input, which is 120000 bytes for NTSC and 144000 for PAL video. - * </para> - * <para> - * This element can perform simple frame dropping with the drop-factor + * + * This element can perform simple frame dropping with the #GstDVDec:drop-factor * property. Setting this property to a value N > 1 will only decode every * Nth frame. - * </para> + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.dv ! dvdemux name=demux ! dvdec ! xvimagesink - * </programlisting> - * This pipeline decodes and renders the raw DV stream to a videosink. - * </para> - * Last reviewed on 2006-02-28 (0.10.3) + * ]| This pipeline decodes and renders the raw DV stream to a videosink. * </refsect2> + * + * Last reviewed on 2006-02-28 (0.10.3) */ #ifdef HAVE_CONFIG_H diff --git a/ext/dv/gstdvdemux.c b/ext/dv/gstdvdemux.c index 39340116..7c7509fe 100644 --- a/ext/dv/gstdvdemux.c +++ b/ext/dv/gstdvdemux.c @@ -30,24 +30,20 @@ /** * SECTION:element-dvdemux * - * <refsect2> - * <para> * dvdemux splits raw DV into its audio and video components. The audio will be * decoded raw samples and the video will be encoded DV video. - * </para> - * <para> - * This element can operate in both push and pull mode depending on the capabilities - * of the upstream peer. - * </para> + * + * This element can operate in both push and pull mode depending on the + * capabilities of the upstream peer. + * + * <refsect2> * <title>Example launch line</title> - * <para> - * <programlisting> + * |[ * gst-launch filesrc location=test.dv ! dvdemux name=demux ! queue ! audioconvert ! alsasink demux. ! queue ! dvdec ! xvimagesink - * </programlisting> - * This pipeline decodes and renders the raw DV stream to an audio and a videosink. - * </para> - * Last reviewed on 2006-02-27 (0.10.3) + * ]| This pipeline decodes and renders the raw DV stream to an audio and a videosink. * </refsect2> + * + * Last reviewed on 2006-02-27 (0.10.3) */ /* DV output has two modes, normal and wide. The resolution is the same in both |