From 78022a6e0c05ce482b798cf638cbd3f901a5094e Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 8 Mar 2017 15:01:13 -0300 Subject: docs: Port all docstring to gtk-doc markdown --- gst/videosignal/gstsimplevideomark.c | 14 +++--- gst/videosignal/gstsimplevideomarkdetect.c | 72 +++++++++--------------------- gst/videosignal/gstvideoanalyse.c | 68 ++++++++-------------------- 3 files changed, 45 insertions(+), 109 deletions(-) (limited to 'gst/videosignal') diff --git a/gst/videosignal/gstsimplevideomark.c b/gst/videosignal/gstsimplevideomark.c index 2a527c32e..ae4d0c02a 100644 --- a/gst/videosignal/gstsimplevideomark.c +++ b/gst/videosignal/gstsimplevideomark.c @@ -18,27 +18,27 @@ */ /** * SECTION:element-simplevideomark + * @title: simplevideomark * @see_also: #GstVideoDetect * * This plugin produces #GstSimpleVideoMark::pattern-count squares in the bottom left - * corner of the video frames. The squares have a width and height of + * corner of the video frames. The squares have a width and height of * respectively #GstSimpleVideoMark:pattern-width and #GstSimpleVideoMark:pattern-height. * Even squares will be black and odd squares will be white. - * + * * After writing the pattern, #GstSimpleVideoMark:pattern-data-count squares after the * pattern squares are produced as the bitarray given in * #GstSimpleVideoMark:pattern-data. 1 bits will produce white squares and 0 bits will * produce black squares. - * + * * The element can be enabled with the #GstSimpleVideoMark:enabled property. It is * mostly used together with the #GstVideoDetect plugin. - * - * - * Example launch line + * + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! simplevideomark ! videoconvert ! ximagesink * ]| Add the default black/white squares at the bottom left of the video frames. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videosignal/gstsimplevideomarkdetect.c b/gst/videosignal/gstsimplevideomarkdetect.c index 1e95c8155..d58cff2e2 100644 --- a/gst/videosignal/gstsimplevideomarkdetect.c +++ b/gst/videosignal/gstsimplevideomarkdetect.c @@ -18,78 +18,46 @@ */ /** * SECTION:element-simplevideomarkdetect + * @title: simplevideomarkdetect * @see_also: #GstVideoMark * * This plugin detects #GstSimpleVideoMarkDetect:pattern-count squares in the bottom left * corner of the video frames. The squares have a width and height of * respectively #GstSimpleVideoMarkDetect:pattern-width and #GstSimpleVideoMarkDetect:pattern-height. * Even squares must be black and odd squares must be white. - * + * * When the pattern has been found, #GstSimpleVideoMarkDetect: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 "GstSimpleVideoMarkDetect" will + * element message called `GstSimpleVideoMarkDetect` 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 #GstSimpleVideoMarkDetect:message property is #TRUE. - * + * * The message's structure contains these fields: - * - * - * - * #gboolean - * "have-pattern": - * if the pattern was found. This field will be set to #TRUE for as long as + * + * * #gboolean`have-pattern`: if the pattern was found. This field will be set to #TRUE for as long as * the pattern was found in the frame and set to FALSE for the first frame * that does not contain the pattern anymore. - * - * - * - * - * #GstClockTime - * "timestamp": - * the timestamp of the buffer that triggered the message. - * - * - * - * - * #GstClockTime - * "stream-time": - * the stream time of the buffer. - * - * - * - * - * #GstClockTime - * "running-time": - * the running_time of the buffer. - * - * - * - * - * #GstClockTime - * "duration": - * the duration of the buffer. - * - * - * - * - * #guint64 - * "data": - * the data-pattern found after the pattern or 0 when have-signal is #FALSE. - * - * - * - * - * - * Example launch line + * + * * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message. + * + * * #GstClockTime `stream-time`: the stream time of the buffer. + * + * * #GstClockTime `running-time`: the running_time of the buffer. + * + * * #GstClockTime `duration`: the duration of the buffer. + * + * * #guint64 `data`: the data-pattern found after the pattern or 0 when have-signal is #FALSE. + * + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! simplevideomarkdetect ! videoconvert ! ximagesink * ]| - * + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videosignal/gstvideoanalyse.c b/gst/videosignal/gstvideoanalyse.c index ea52bdf7d..2723c14fd 100644 --- a/gst/videosignal/gstvideoanalyse.c +++ b/gst/videosignal/gstvideoanalyse.c @@ -18,63 +18,31 @@ */ /** * SECTION:element-videoanalyse + * @title: videoanalyse * * This plugin analyses every video frame and if the #GstVideoAnalyse:message * property is #TRUE, posts an element message with video statistics called - * "GstVideoAnalyse". + * `GstVideoAnalyse`. * * The message's structure contains these fields: - * - * - * - * #GstClockTime - * "timestamp": - * the timestamp of the buffer that triggered the message. - * - * - * - * - * #GstClockTime - * "stream-time": - * the stream time of the buffer. - * - * - * - * - * #GstClockTime - * "running-time": - * the running_time of the buffer. - * - * - * - * - * #GstClockTime - * "duration": - * the duration of the buffer. - * - * - * - * - * #gdouble - * "luma-average": - * the average brightness of the frame. Range: 0.0-1.0 - * - * - * - * - * #gdouble - * "luma-variance": - * the brightness variance of the frame. - * - * - * - * - * - * Example launch line + * + * * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message. + * + * * #GstClockTime `stream-time`: the stream time of the buffer. + * + * * #GstClockTime `running-time`: the running_time of the buffer. + * + * * #GstClockTime`duration`:the duration of the buffer. + * + * * #gdouble`luma-average`: the average brightness of the frame. Range: 0.0-1.0 + * + * * #gdouble`luma-variance`: the brightness variance of the frame. + * + * ## Example launch line * |[ * gst-launch-1.0 -m videotestsrc ! videoanalyse ! videoconvert ! ximagesink - * ]| This pipeline emits messages to the console for each frame that has been analysed. - * + * ]| This pipeline emits messages to the console for each frame that has been analysed. + * */ #ifdef HAVE_CONFIG_H -- cgit v1.2.3