From b62583b216f04d8b03346897c11f8e239104dd59 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sourceforge.net>
Date: Mon, 16 Jun 2008 07:30:34 +0000
Subject: Final round of doc updates.

Original commit message from CVS:
* gst/rtpmanager/gstrtpjitterbuffer.c:
* gst/speed/gstspeed.c:
* gst/speexresample/gstspeexresample.c:
* gst/videosignal/gstvideoanalyse.c:
* gst/videosignal/gstvideodetect.c:
* gst/videosignal/gstvideomark.c:
* sys/dvb/gstdvbsrc.c:
* sys/oss4/oss4-mixer.c:
* sys/oss4/oss4-sink.c:
* sys/oss4/oss4-source.c:
* sys/wininet/gstwininetsrc.c:
Final round of doc updates.
---
 gst/videosignal/gstvideomark.c | 36 ++++++++++++++++--------------------
 1 file changed, 16 insertions(+), 20 deletions(-)

(limited to 'gst/videosignal/gstvideomark.c')

diff --git a/gst/videosignal/gstvideomark.c b/gst/videosignal/gstvideomark.c
index 1ec75773..1cd42427 100644
--- a/gst/videosignal/gstvideomark.c
+++ b/gst/videosignal/gstvideomark.c
@@ -19,30 +19,26 @@
 
 /**
  * SECTION:element-videomark
+ * @see_also: #GstVideoDetect
  *
+ * This plugin produces #GstVideoMark::pattern-count squares in the bottom left
+ * corner of the video frames. The squares have a width and height of 
+ * respectively #GstVideoMark:pattern-width and #GstVideoMark:pattern-height.
+ * Even squares will be black and odd squares will be white.
+ * 
+ * After writing the pattern, #GstVideoMark:pattern-data-count squares after the
+ * pattern squares are produced as the bitarray given in
+ * #GstVideoMark:pattern-data. 1 bits will produce white squares and 0 bits will
+ * produce black squares.
+ * 
+ * The element can be enabled with the #GstVideoMark:enabled property. It is
+ * mostly used together with the #GstVideoDetect plugin.
+ * 
  * <refsect2>
- * <para>
- * This plugin produces ::pattern-count squares in the bottom left corner of
- * the video frames. The squares have a width and height of respectively
- * ::pattern-width and ::patern-height. Even squares will be black and odd
- * squares will be white.
- * </para>
- * <para>
- * After writing the pattern, ::pattern-data-count squares after the
- * pattern squares are produced as the bitarray given in ::pattern-data. 1 bits
- * will produce white squares and 0 bits will produce black squares.
- * </para>
- * <para>
- * The element can be enabled with the ::enabled property. It is mostly used
- * together with the videodetect plugin.
- * </para>
  * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
  * gst-launch videotestsrc ! videomark ! ximagesink
- * </programlisting>
- * Add the default black/white squares at the bottom left of the video frames.
- * </para>
+ * ]| Add the default black/white squares at the bottom left of the video frames.
  * </refsect2>
  *
  * Last reviewed on 2007-06-01 (0.10.6)
-- 
cgit v1.2.1