diff options
author | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-03-08 15:01:13 -0300 |
---|---|---|
committer | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-04-12 12:57:57 -0300 |
commit | 78022a6e0c05ce482b798cf638cbd3f901a5094e (patch) | |
tree | 9725b5939d840f6eb3e8f39e032866e82413cb83 /gst/debugutils | |
parent | 90f766cc518b4fde651162d6e0c7d190373e3c61 (diff) |
docs: Port all docstring to gtk-doc markdown
Diffstat (limited to 'gst/debugutils')
-rw-r--r-- | gst/debugutils/fpsdisplaysink.c | 6 | ||||
-rw-r--r-- | gst/debugutils/gstchopmydata.c | 9 | ||||
-rw-r--r-- | gst/debugutils/gstdebugspy.c | 6 | ||||
-rw-r--r-- | gst/debugutils/gsterrorignore.c | 9 | ||||
-rw-r--r-- | gst/debugutils/gstwatchdog.c | 6 |
5 files changed, 18 insertions, 18 deletions
diff --git a/gst/debugutils/fpsdisplaysink.c b/gst/debugutils/fpsdisplaysink.c index 00f89a3e7..9774b6a52 100644 --- a/gst/debugutils/fpsdisplaysink.c +++ b/gst/debugutils/fpsdisplaysink.c @@ -19,18 +19,18 @@ /** * SECTION:element-fpsdisplaysink + * @title: fpsdisplaysink * * Can display the current and average framerate as a testoverlay or on stdout. * - * <refsect2> - * <title>Example launch lines</title> + * ## Example launch lines * |[ * gst-launch-1.0 videotestsrc ! fpsdisplaysink * gst-launch-1.0 videotestsrc ! fpsdisplaysink text-overlay=false * gst-launch-1.0 filesrc location=video.avi ! decodebin name=d ! queue ! fpsdisplaysink d. ! queue ! fakesink sync=true * gst-launch-1.0 playbin uri=file:///path/to/video.avi video-sink="fpsdisplaysink" audio-sink=fakesink * ]| - * </refsect2> + * */ /* FIXME: * - can we avoid plugging the textoverlay? diff --git a/gst/debugutils/gstchopmydata.c b/gst/debugutils/gstchopmydata.c index c382d3274..bed08befb 100644 --- a/gst/debugutils/gstchopmydata.c +++ b/gst/debugutils/gstchopmydata.c @@ -18,26 +18,25 @@ */ /** * SECTION:element-gstchopmydata + * @title: gstchopmydata * * The chopmydata element takes an incoming stream and chops it up * into randomly sized buffers. Size of outgoing buffers are determined * by the max-size, min-size, and step-size properties. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v audiotestsrc num-buffers=10 ! chopmydata min-size=100 * max-size=200 step-size=2 ! fakesink -v * ]| - * + * * This pipeline will create 10 buffers that are by default 2048 bytes * each (1024 samples each), and chop them up into buffers that range * in size from 100 bytes to 200 bytes, with the restriction that sizes * are a multiple of 2. This restriction is important, because the * default sample size for audiotestsrc is 2 bytes (one channel, 16-bit * audio). - * - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/gstdebugspy.c b/gst/debugutils/gstdebugspy.c index fed2db180..ebf050f6d 100644 --- a/gst/debugutils/gstdebugspy.c +++ b/gst/debugutils/gstdebugspy.c @@ -22,16 +22,16 @@ /** * SECTION:element-debugspy + * @title: debugspy * * A spy element that can provide information on buffers going through it, with * bus messages. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -m videotestsrc ! debugspy ! fakesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/gsterrorignore.c b/gst/debugutils/gsterrorignore.c index ed42a0505..30e5beee2 100644 --- a/gst/debugutils/gsterrorignore.c +++ b/gst/debugutils/gsterrorignore.c @@ -20,17 +20,18 @@ /** * SECTION:element-errorignore + * @title: errorignore * * Passes through all packets, until it encounters GST_FLOW_ERROR or * GST_FLOW_NOT_NEGOTIATED (configurable). At that point it will unref the - * buffers and return GST_FLOW_OK (configurable) - until the next + * buffers and return GST_FLOW_OK (configurable) - until the next * READY_TO_PAUSED, RECONFIGURE or FLUSH_STOP. - * <refsect2> - * <title>Example launch line</title> + * + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! errorignore ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/gstwatchdog.c b/gst/debugutils/gstwatchdog.c index 0a4c12e7b..1824cbf3b 100644 --- a/gst/debugutils/gstwatchdog.c +++ b/gst/debugutils/gstwatchdog.c @@ -19,6 +19,7 @@ */ /** * SECTION:element-gstwatchdog + * @title: watchdog * * The watchdog element watches buffers and events flowing through * a pipeline. If no buffers are seen for a configurable amount of @@ -32,12 +33,11 @@ * This element is currently intended for transcoding pipelines, * although may be useful in other contexts. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v fakesrc ! watchdog ! fakesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H |