docs: Port all docstring to gtk-doc markdown

22 files changed, 87 insertions, 98 deletions

diff --git a/ext/gl/gstglbumper.c b/ext/gl/gstglbumper.c
index 9fdb4a079..8dd812cb8 100644
--- a/ext/gl/gstglbumper.c
+++ b/ext/gl/gstglbumper.c
@@ -21,16 +21,16 @@
 
 /**
  * SECTION:element-glbumper
+ * @title: glbumper
  *
  * Bump mapping using the normal method.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 -v videotestsrc ! glupload ! glbumper location=normalmap.bmp ! glimagesink
  * ]| A pipeline to test normal mapping.
  * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglcolorbalance.c b/ext/gl/gstglcolorbalance.c
index 33b5a50a3..c2482a3d6 100644
--- a/ext/gl/gstglcolorbalance.c
+++ b/ext/gl/gstglcolorbalance.c
@@ -22,16 +22,16 @@
 
 /**
  * SECTION:element-glcolorbalance
+ * @title: glcolorbalance
  *
  * Adjusts brightness, contrast, hue, saturation on a video stream.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! glcolorbalance saturation=0.0 ! glcolorconvert ! gldownload ! ximagesink
  * ]| This pipeline converts the image to black and white by setting the
  * saturation to 0.0.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglcolorscale.c b/ext/gl/gstglcolorscale.c
index 2ca5480e9..b7b0709dc 100644
--- a/ext/gl/gstglcolorscale.c
+++ b/ext/gl/gstglcolorscale.c
@@ -20,17 +20,15 @@
 
 /**
  * SECTION:element-glcolorscale
+ * @title: glcolorscale
  *
  * video frame scaling and colorspace conversion.
  *
- * <refsect2>
- * <title>Scaling and Color space conversion</title>
- * <para>
+ * ## Scaling and Color space conversion
+ *
  * Equivalent to glupload ! gldownload.
- * </para>
- * </refsect2>
- * <refsect2>
- * <title>Examples</title>
+ *
+ * ## Examples
  * |[
  * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glcolorscale ! ximagesink
  * ]| A pipeline to test colorspace conversion.
@@ -40,7 +38,7 @@
  *   video/x-raw, width=320, height=240, format=YV12 ! videoconvert ! autovideosink
  * ]| A pipeline to test hardware scaling and colorspace conversion.
  * FBO and GLSL are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstgldeinterlace.c b/ext/gl/gstgldeinterlace.c
index 568f26702..dbc2c24d4 100644
--- a/ext/gl/gstgldeinterlace.c
+++ b/ext/gl/gstgldeinterlace.c
@@ -20,16 +20,16 @@
 
 /**
  * SECTION:element-deinterlace
+ * @title: deinterlace
  *
  * Deinterlacing using based on fragment shaders.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! gldeinterlace ! glimagesink
  * ]|
  * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstgldifferencematte.c b/ext/gl/gstgldifferencematte.c
index b50e69bf7..aa1092a17 100644
--- a/ext/gl/gstgldifferencematte.c
+++ b/ext/gl/gstgldifferencematte.c
@@ -20,16 +20,16 @@
 
 /**
  * SECTION:element-gldifferencematte.
+ * @title: gldifferencematte.
  *
  * Saves a background frame and replace it with a pixbuf.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! gldifferencemate location=backgroundimagefile ! glimagesink
  * ]|
  * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstgleffects.c b/ext/gl/gstgleffects.c
index 2af3368af..d8a7da107 100644
--- a/ext/gl/gstgleffects.c
+++ b/ext/gl/gstgleffects.c
@@ -20,16 +20,16 @@
 
 /**
  * SECTION:element-gleffects.
+ * @title: gleffects.
  *
  * GL Shading Language effects.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! gleffects effect=5 ! glimagesink
  * ]|
  * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglfilterapp.c b/ext/gl/gstglfilterapp.c
index 925373b89..fc2e6ac5e 100644
--- a/ext/gl/gstglfilterapp.c
+++ b/ext/gl/gstglfilterapp.c
@@ -20,20 +20,18 @@
 
 /**
  * SECTION:element-glfilterapp
+ * @title: glfilterapp
  *
  * The resize and redraw callbacks can be set from a client code.
  *
- * <refsect2>
- * <title>CLient callbacks</title>
- * <para>
- * The graphic scene can be written from a client code through the 
+ * ## CLient callbacks
+ *
+ * The graphic scene can be written from a client code through the
  * two glfilterapp properties.
- * </para>
- * </refsect2>
- * <refsect2>
- * <title>Examples</title>
+ *
+ * ## Examples
  * see gst-plugins-gl/tests/examples/generic/recordgraphic
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglfiltercube.c b/ext/gl/gstglfiltercube.c
index 735d45e5e..427782afd 100644
--- a/ext/gl/gstglfiltercube.c
+++ b/ext/gl/gstglfiltercube.c
@@ -20,11 +20,11 @@
 
 /**
  * SECTION:element-glfiltercube
+ * @title: glfiltercube
  *
  * The resize and redraw callbacks can be set from a client code.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 -v videotestsrc ! glfiltercube ! glimagesink
  * ]| A pipeline to mpa textures on the 6 cube faces..
@@ -37,7 +37,7 @@
  * gst-launch-1.0 -v videotestsrc ! video/x-raw, width=640, height=480  ! glfiltercube ! glimagesink
  * ]| Resize scene before drawing the cube.
  * The scene size is greater than the input video size.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglfilterglass.c b/ext/gl/gstglfilterglass.c
index 254199dd5..ea20239a4 100644
--- a/ext/gl/gstglfilterglass.c
+++ b/ext/gl/gstglfilterglass.c
@@ -21,11 +21,11 @@
 
 /**
  * SECTION:element-glfilterglass
+ * @title: glfilterglass
  *
  * Map textures on moving glass.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 -v videotestsrc ! glfilterglass ! glimagesink
  * ]| A pipeline inspired from http://www.mdk.org.pl/2007/11/17/gl-colorspace-conversions
@@ -33,7 +33,7 @@
  * |[
  * gst-launch-1.0 -v videotestsrc ! glfilterglass ! video/x-raw, width=640, height=480 ! glimagesink
  * ]| The scene is greater than the input size.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglfilterreflectedscreen.c b/ext/gl/gstglfilterreflectedscreen.c
index fb1533890..62ccd9bf7 100644
--- a/ext/gl/gstglfilterreflectedscreen.c
+++ b/ext/gl/gstglfilterreflectedscreen.c
@@ -20,15 +20,15 @@
 
 /**
  * SECTION:element-glfilterreflectedscreen
+ * @title: glfilterreflectedscreen
  *
  * Map Video Texture upon a screen, on a reflecting surface
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! glfilterreflectedscreen ! glimagesink
  * ]|
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglfiltershader.c b/ext/gl/gstglfiltershader.c
index f3434690b..8f5a990cf 100644
--- a/ext/gl/gstglfiltershader.c
+++ b/ext/gl/gstglfiltershader.c
@@ -21,11 +21,11 @@
 
 /**
  * SECTION:element-glshader
+ * @title: glshader
  *
  * OpenGL fragment shader filter
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! glshader fragment="\"`cat myshader.frag`\"" ! glimagesink
  * ]|
@@ -45,13 +45,12 @@
  * uniform float time;
  * uniform float width;
  * uniform float height;
- * 
+ *
  * void main () {
  *   gl_FragColor = texture2D( tex, v_texcoord );
  * }
  * ]|
  *
- * </refsect2>
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
diff --git a/ext/gl/gstglimagesink.c b/ext/gl/gstglimagesink.c
index 1c8d314f2..f6a61ac92 100644
--- a/ext/gl/gstglimagesink.c
+++ b/ext/gl/gstglimagesink.c
@@ -23,6 +23,7 @@
 
 /**
  * SECTION:element-glimagesink
+ * @title: glimagesink
  *
  * glimagesink renders video frames to a drawable on a local or remote
  * display using OpenGL. This element can receive a Window ID from the
@@ -34,28 +35,23 @@
  * See the #GstGLDisplay documentation for a list of environment variables that
  * can override window/platform detection.
  *
- * <refsect2>
- * <title>Scaling</title>
- * <para>
+ * ## Scaling
+ *
  * Depends on the driver, OpenGL handles hardware accelerated
  * scaling of video frames. This means that the element will just accept
  * incoming video frames no matter their geometry and will then put them to the
  * drawable scaling them on the fly. Using the #GstGLImageSink:force-aspect-ratio
  * property it is possible to enforce scaling with a constant aspect ratio,
  * which means drawing black borders around the video frame.
- * </para>
- * </refsect2>
- * <refsect2>
- * <title>Events</title>
- * <para>
+ *
+ * ## Events
+ *
  * Through the gl thread, glimagesink handle some events coming from the drawable
  * to manage its appearance even when the data is not flowing (GST_STATE_PAUSED).
  * That means that even when the element is paused, it will receive expose events
  * from the drawable and draw the latest frame with correct borders/aspect-ratio.
- * </para>
- * </refsect2>
- * <refsect2>
- * <title>Examples</title>
+ *
+ * ## Examples
  * |[
  * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glimagesink
  * ]| A pipeline to test hardware scaling.
@@ -80,7 +76,7 @@
  * ]| The graphic FPS scene can be greater than the input video FPS.
  * The graphic scene can be written from a client code through the
  * two glfilterapp properties.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglmosaic.c b/ext/gl/gstglmosaic.c
index fcd4926a7..77aec599c 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
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## 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.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstgloverlay.c b/ext/gl/gstgloverlay.c
index 8c21bac77..173d11820 100644
--- a/ext/gl/gstgloverlay.c
+++ b/ext/gl/gstgloverlay.c
@@ -20,16 +20,16 @@
 
 /**
  * SECTION:element-gloverlay
+ * @title: gloverlay
  *
  * Overlay GL video texture with a PNG image
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! gloverlay location=image.jpg ! glimagesink
  * ]|
  * FBO (Frame Buffer Object) is required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglstereomix.c b/ext/gl/gstglstereomix.c
index 18e7111a7..78a2934fa 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.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## 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.
- * </refsect2>
+ *
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
diff --git a/ext/gl/gstglstereosplit.c b/ext/gl/gstglstereosplit.c
index 5650ab4d6..933f3c593 100644
--- a/ext/gl/gstglstereosplit.c
+++ b/ext/gl/gstglstereosplit.c
@@ -20,16 +20,16 @@
 
 /**
  * SECTION:element-glstereosplit
+ * @title: glstereosplit
  *
  * Receive a stereoscopic video stream and split into left/right
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glstereosplit name=s ! queue ! glimagesink s. ! queue ! glimagesink
  * ]|
  * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstgltestsrc.c b/ext/gl/gstgltestsrc.c
index 83218b4ac..e9c7df85a 100644
--- a/ext/gl/gstgltestsrc.c
+++ b/ext/gl/gstgltestsrc.c
@@ -23,21 +23,19 @@
 
 /**
  * SECTION:element-gltestsrc
+ * @title: gltestsrc
  *
- * <refsect2>
- * <para>
  * The gltestsrc element is used to produce test video texture.
  * The video test produced can be controlled with the "pattern"
  * property.
- * </para>
- * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ *
+ * ## Example launch line
+ *
+ * |[
  * gst-launch-1.0 -v gltestsrc pattern=smpte ! glimagesink
- * </programlisting>
+ * ]|
  * Shows original SMPTE color bars in a window.
- * </para>
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstgltransformation.c b/ext/gl/gstgltransformation.c
index f6c9e3f26..729a9f653 100644
--- a/ext/gl/gstgltransformation.c
+++ b/ext/gl/gstgltransformation.c
@@ -21,11 +21,11 @@
 
 /**
  * SECTION:element-gltransformation
+ * @title: gltransformation
  *
  * Transforms video on the GPU.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 gltestsrc ! gltransformation rotation-z=45 ! glimagesink
  * ]| A pipeline to rotate by 45 degrees
@@ -38,7 +38,7 @@
  * |[
  * gst-launch-1.0 gltestsrc ! gltransformation rotation-x=-45 ortho=True ! glimagesink
  * ]| Rotate the video around the X-Axis by -45° with an orthographic projection
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglvideoflip.c b/ext/gl/gstglvideoflip.c
index 5d2dac5ee..d5bb2ac57 100644
--- a/ext/gl/gstglvideoflip.c
+++ b/ext/gl/gstglvideoflip.c
@@ -20,15 +20,15 @@
 
 /**
  * SECTION:element-glvideo_flip
+ * @title: glvideo_flip
  *
  * Transforms video on the GPU.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! glvideoflip method=clockwise ! glimagesinkelement
  * ]| This pipeline flips the test image 90 degrees clockwise.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglvideomixer.c b/ext/gl/gstglvideomixer.c
index ebd682752..5df126d87 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.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## 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 \
  * ]|
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstglviewconvert.c b/ext/gl/gstglviewconvert.c
index 617df449d..670305c81 100644
--- a/ext/gl/gstglviewconvert.c
+++ b/ext/gl/gstglviewconvert.c
@@ -22,14 +22,14 @@
 
 /**
  * SECTION:element-glviewconvert
+ * @title: glviewconvert
  *
  * Convert stereoscopic video between different representations using fragment shaders.
  *
  * The element can use either property settings or caps negotiation to choose the
  * input and output formats to process.
  *
- * <refsect2>
- * <title>Examples</title>
+ * ## Examples
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! glviewconvert ! glimagesink
  * ]| Simple placebo example demonstrating identity passthrough of mono video
@@ -39,7 +39,7 @@
  * ]| Force re-interpretation of the input checkers pattern as a side-by-side stereoscopic
  *    image and display in glimagesink.
  * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
diff --git a/ext/gl/gstopengl.c b/ext/gl/gstopengl.c
index 4a8c4d6a1..75f8d3332 100644
--- a/ext/gl/gstopengl.c
+++ b/ext/gl/gstopengl.c
@@ -23,20 +23,20 @@
 
 /**
  * SECTION:plugin-opengl
+ * @title: GstOpengl
  *
  * Cross-platform OpenGL plugin.
- * <refsect2>
- * <title>Debugging</title>
- * </refsect2>
- * <refsect2>
- * <title>Examples</title>
+ *
+ * ## Debugging
+ *
+ * ## Examples
  * |[
  * gst-launch-1.0 --gst-debug=gldisplay:3 videotestsrc ! glimagesink
  * ]| A debugging pipeline.
   |[
  * GST_DEBUG=gl*:6 gst-launch-1.0 videotestsrc ! glimagesink
  * ]| A debugging pipelines related to shaders.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H