From 2bf26969450b7a52031d17fd274b38f39fdfca3e Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 8 Mar 2017 15:01:13 -0300 Subject: [PATCH] docs: Port all docstring to gtk-doc markdown --- ext/gl/gstglmosaic.c | 6 ++-- ext/gl/gstglstereomix.c | 8 ++--- ext/gl/gstglvideomixer.c | 6 ++-- gst-libs/gst/video/gstvideoaggregator.c | 1 + gst/compositor/compositor.c | 44 +++++++------------------ 5 files changed, 23 insertions(+), 42 deletions(-) diff --git a/ext/gl/gstglmosaic.c b/ext/gl/gstglmosaic.c index fcd4926a77..77aec599cd 100644 --- a/ext/gl/gstglmosaic.c +++ b/ext/gl/gstglmosaic.c @@ -20,14 +20,14 @@ /** * SECTION:element-glmosaic + * @title: glmosaic * * glmixer sub element. N gl sink pads to 1 source pad. * N + 1 OpenGL contexts shared together. * N <= 6 because the rendering is more a like a cube than a mosaic * Each opengl input stream is rendered on a cube face * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! video/x-raw, format=YUY2 ! queue ! glmosaic name=m ! glimagesink \ * videotestsrc pattern=12 ! video/x-raw, format=I420, framerate=5/1, width=100, height=200 ! queue ! m. \ @@ -37,7 +37,7 @@ * videotestsrc ! gleffects effect=6 ! queue ! m. * ]| * FBO (Frame Buffer Object) is required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglstereomix.c b/ext/gl/gstglstereomix.c index 18e7111a7f..78a2934fad 100644 --- a/ext/gl/gstglstereomix.c +++ b/ext/gl/gstglstereomix.c @@ -23,6 +23,7 @@ /** * SECTION:element-glstereomix + * @title: glstereomix * * Combine 2 input streams to produce a stereoscopic output * stream. Input views are taken from the left pad and right pad @@ -34,8 +35,7 @@ * The multiview representation on the output is chosen according to * the downstream caps. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc pattern=ball name=left \ * videotestsrc name=right glstereomix name=mix \ @@ -52,10 +52,10 @@ * right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \ * mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \ * glcolorconvert ! gldownload ! queue ! x264enc ! h264parse ! \ - * mp4mux ! progressreport ! filesink location=output.mp4 + * mp4mux ! progressreport ! filesink location=output.mp4 * ]| Mix the input from a camera to the left view, and videotestsrc to the right view, * and encode as a top-bottom frame packed H.264 video. - * + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gl/gstglvideomixer.c b/ext/gl/gstglvideomixer.c index ebd6827524..5df126d878 100644 --- a/ext/gl/gstglvideomixer.c +++ b/ext/gl/gstglvideomixer.c @@ -20,13 +20,13 @@ /** * SECTION:element-glvideomixer + * @title: glvideomixer * * Composites a number of streams into a single output scene using OpenGL in * a similar fashion to compositor and videomixer. See the compositor plugin * for documentation about the #GstGLVideoMixerPad properties. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 glvideomixer name=m ! glimagesink \ * videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \ @@ -36,7 +36,7 @@ * videotestsrc ! glupload ! glfiltercube ! queue ! m. \ * videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \ * ]| - * + * */ #ifdef HAVE_CONFIG_H diff --git a/gst-libs/gst/video/gstvideoaggregator.c b/gst-libs/gst/video/gstvideoaggregator.c index e17c111d45..1616b27244 100644 --- a/gst-libs/gst/video/gstvideoaggregator.c +++ b/gst-libs/gst/video/gstvideoaggregator.c @@ -20,6 +20,7 @@ /** * SECTION:gstvideoaggregator + * @title: GstVideoAggregator * @short_description: Base class for video aggregators * * VideoAggregator can accept AYUV, ARGB and BGRA video streams. For each of the requested diff --git a/gst/compositor/compositor.c b/gst/compositor/compositor.c index 068d2bb721..fab75c6394 100644 --- a/gst/compositor/compositor.c +++ b/gst/compositor/compositor.c @@ -22,6 +22,7 @@ /** * SECTION:element-compositor + * @title: compositor * * Compositor can accept AYUV, ARGB and BGRA video streams. For each of the requested * sink pads it will compare the incoming geometry and framerate to define the @@ -29,40 +30,19 @@ * biggest incoming video stream and the framerate of the fastest incoming one. * * Compositor will do colorspace conversion. - * + * * Individual parameters for each input stream can be configured on the * #GstCompositorPad: * - * - * - * "xpos": The x-coordinate position of the top-left corner of the picture - * (#gint) - * - * - * "ypos": The y-coordinate position of the top-left corner of the picture - * (#gint) - * - * - * "width": The width of the picture; the input will be scaled if necessary - * (#gint) - * - * - * "height": The height of the picture; the input will be scaled if necessary - * (#gint) - * - * - * "alpha": The transparency of the picture; between 0.0 and 1.0. The blending - * is a simple copy when fully-transparent (0.0) and fully-opaque (1.0). - * (#gdouble) - * - * - * "zorder": The z-order position of the picture in the composition - * (#guint) - * - * + * * "xpos": The x-coordinate position of the top-left corner of the picture (#gint) + * * "ypos": The y-coordinate position of the top-left corner of the picture (#gint) + * * "width": The width of the picture; the input will be scaled if necessary (#gint) + * * "height": The height of the picture; the input will be scaled if necessary (#gint) + * * "alpha": The transparency of the picture; between 0.0 and 1.0. The blending + * is a simple copy when fully-transparent (0.0) and fully-opaque (1.0). (#gdouble) + * * "zorder": The z-order position of the picture in the composition (#guint) * - * - * Sample pipelines + * ## Sample pipelines * |[ * gst-launch-1.0 \ * videotestsrc pattern=1 ! \ @@ -85,7 +65,7 @@ * compositor name=comp ! videoconvert ! ximagesink \ * videotestsrc ! \ * video/x-raw, framerate=\(fraction\)5/1, width=320, height=240 ! comp. - * ]| A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending). + * ]| A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending). * |[ * gst-launch-1.0 videotestsrc pattern=1 ! \ * video/x-raw,format =I420, framerate=\(fraction\)10/1, width=100, height=100 ! \ @@ -103,7 +83,7 @@ * "video/x-raw,format=AYUV,width=800,height=600,framerate=(fraction)10/1" ! \ * timeoverlay ! queue2 ! comp. * ]| A pipeline to demonstrate synchronized compositing (the second stream starts after 3 seconds) - * + * */ #ifdef HAVE_CONFIG_H