summaryrefslogtreecommitdiff
path: root/gst/videosignal
diff options
context:
space:
mode:
authorStefan Kost <ensonic@users.sourceforge.net>2008-06-16 07:30:34 +0000
committerStefan Kost <ensonic@users.sourceforge.net>2008-06-16 07:30:34 +0000
commitb62583b216f04d8b03346897c11f8e239104dd59 (patch)
treeac834a4bf071f43c9af2169c00e3518b46d96976 /gst/videosignal
parent68993006c374a92474db6e908f7d3c13981bfed9 (diff)
downloadgstreamer-plugins-bad-b62583b216f04d8b03346897c11f8e239104dd59.tar.gz
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.
Diffstat (limited to 'gst/videosignal')
-rw-r--r--gst/videosignal/gstvideoanalyse.c21
-rw-r--r--gst/videosignal/gstvideodetect.c40
-rw-r--r--gst/videosignal/gstvideomark.c36
3 files changed, 42 insertions, 55 deletions
diff --git a/gst/videosignal/gstvideoanalyse.c b/gst/videosignal/gstvideoanalyse.c
index 5678c5eac..ee84be32e 100644
--- a/gst/videosignal/gstvideoanalyse.c
+++ b/gst/videosignal/gstvideoanalyse.c
@@ -20,11 +20,10 @@
/**
* SECTION:element-videoanalyse
*
- * <refsect2>
- * <para>
- * This plugin analyses every video frame and if the <link
- * linkend="GstVideoAnalyse--message">message property</link> is #TRUE, posts an element
- * message with video statistics called <classname>&quot;GstVideoAnalyse&quot;</classname>.
+ * This plugin analyses every video frame and if the #GstVideoAnalyse:message
+ * property is #TRUE, posts an element message with video statistics called
+ * <classname>&quot;GstVideoAnalyse&quot;</classname>.
+ *
* The message's structure contains these fields:
* <itemizedlist>
* <listitem>
@@ -69,15 +68,13 @@
* the brightness variance of the frame.
* </para>
* </listitem>
- * </itemizedlist>
- * </para>
+ * </itemizedlist>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch -m videotestsrc ! videoanalyse ! ffmpegcolorspace ! ximagesink
- * </programlisting>
- * This pipeline emits messages to the console for each frame that has been analysed.
- * </para>
+ * ]| This pipeline emits messages to the console for each frame that has been analysed.
* </refsect2>
*
* Last reviewed on 2007-05-30 (0.10.5)
diff --git a/gst/videosignal/gstvideodetect.c b/gst/videosignal/gstvideodetect.c
index 90293f6d8..7e3b86530 100644
--- a/gst/videosignal/gstvideodetect.c
+++ b/gst/videosignal/gstvideodetect.c
@@ -19,29 +19,24 @@
/**
* SECTION:element-videodetect
+ * @see_also: #GstVideoMark
*
- * <refsect2>
- * <para>
- * This plugin detects ::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 must be black and odd
- * squares must be white.
- * </para>
- * <para>
- * When the pattern has been found, ::pattern-data-count squares after the
- * pattern squares are read as a bitarray. White squares represent a 1 bit and
- * black squares a 0 bit. The bitarray will will included in the element message
- * that is posted (see below).
- * </para>
- * <para>
+ * This plugin detects #GstVideoDetect:pattern-count squares in the bottom left
+ * corner of the video frames. The squares have a width and height of
+ * respectively #GstVideoDetect:pattern-width and #GstVideoDetect:pattern-height.
+ * Even squares must be black and odd squares must be white.
+ *
+ * When the pattern has been found, #GstVideoDetect:pattern-data-count squares
+ * after the pattern squares are read as a bitarray. White squares represent a 1
+ * bit and black squares a 0 bit. The bitarray will will included in the element
+ * message that is posted (see below).
+ *
* After the pattern has been found and the data pattern has been read, an
* element message called <classname>&quot;GstVideoDetect&quot;</classname> will
* be posted on the bus. If the pattern is no longer found in the frame, the
* same element message is posted with the have-pattern field set to #FALSE.
- * The message is only posted if the <link linkend="GstVideoDetect--message">message
- * property</link> is #TRUE.
- * </para>
- * <para>
+ * The message is only posted if the #GstVideoDetect:message property is #TRUE.
+ *
* The message's structure contains these fields:
* <itemizedlist>
* <listitem>
@@ -89,13 +84,12 @@
* </para>
* </listitem>
* </itemizedlist>
- * </para>
+ *
+ * <refsect2>
* <title>Example launch line</title>
- * <para>
- * <programlisting>
+ * |[
* gst-launch videotestsrc ! videodetect ! ffmpegcolorspace ! ximagesink
- * </programlisting>
- * </para>
+ * ]|
* </refsect2>
*
* Last reviewed on 2007-05-30 (0.10.5)
diff --git a/gst/videosignal/gstvideomark.c b/gst/videosignal/gstvideomark.c
index 1ec75773c..1cd424271 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)