geometrictransform: add headers with example launch lines

Add description headers for all geometrictransform elements so we can have
gst-launch-1.0 example launch lines for all of them.

diff --git a/gst/geometrictransform/gstbulge.c b/gst/geometrictransform/gstbulge.c
index 4baf223573a2fffbbb1d2847b50f7d4501638696..98a7849ba01549a3c90276840b391a6e9bd1065f 100644 (file)
--- a/gst/geometrictransform/gstbulge.c
+++ b/gst/geometrictransform/gstbulge.c
@@ -41,6 +41,21 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-bulge
+ * @see_also: geometrictransform
+ *
+ * Bugle is a geometric image transform element. It adds a protuberance in the
+ * center point.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! bulge ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif

diff --git a/gst/geometrictransform/gstcircle.c b/gst/geometrictransform/gstcircle.c
index cf6ab01d9aacaaf25f7e32a1bdb47b5393510bf9..da4f48b0d6ef2b9e1f8910dd3849c649f536ea69 100644 (file)
--- a/gst/geometrictransform/gstcircle.c
+++ b/gst/geometrictransform/gstcircle.c
@@ -47,6 +47,20 @@
  * his code.
  */
 
+/**
+ * SECTION:element-circle
+ * @see_also: geometrictransform
+ *
+ * Circle is a geometric image transform element. It warps the picture into an
+ * arc shaped form.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! circle ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstdiffuse.c b/gst/geometrictransform/gstdiffuse.c
index 97225c13a9f0828cafec755ab99379bd7b82941d..03009c724a7825d60a7599d59193892653fee315 100644 (file)
--- a/gst/geometrictransform/gstdiffuse.c
+++ b/gst/geometrictransform/gstdiffuse.c
@@ -47,6 +47,20 @@
  * his code.
  */
 
+/**
+ * SECTION:element-diffuse
+ * @see_also: geometrictransform
+ *
+ * Diffuse is a geometric image transform element. It diffuses the image by
+ * moving its pixels in random directions.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! diffuse ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstfisheye.c b/gst/geometrictransform/gstfisheye.c
index 0d9f2b9c21512f58a5a9721e6acd3205b46911dd..d08069c2cff5f408a056d137a0bb73b7caad8c7a 100644 (file)
--- a/gst/geometrictransform/gstfisheye.c
+++ b/gst/geometrictransform/gstfisheye.c
@@ -41,6 +41,21 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-fisheye
+ * @see_also: geometrictransform
+ *
+ * Fisheye is a geometric image transform element. It simulates a fisheye lens
+ * by zooming on the center of the image and compressing the edges.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! fisheye ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif

diff --git a/gst/geometrictransform/gstkaleidoscope.c b/gst/geometrictransform/gstkaleidoscope.c
index 554655851065a705b7c2663dc236fc9729e172cf..bb1bdfcb81f878e58830f5a6cecd632edea52738 100644 (file)
--- a/gst/geometrictransform/gstkaleidoscope.c
+++ b/gst/geometrictransform/gstkaleidoscope.c
@@ -47,6 +47,20 @@
  * his code.
  */
 
+/**
+ * SECTION:element-kaleidoscope
+ * @see_also: geometrictransform
+ *
+ * The kaleidscope element applies 'kaleidoscope' geometric transform to the
+ * image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! kaleidoscope ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstmarble.c b/gst/geometrictransform/gstmarble.c
index a268a3d6db120ae53633fe53e67688d2d8fb4818..68984536693cfc0371a0eb7567980f89df9f0e87 100644 (file)
--- a/gst/geometrictransform/gstmarble.c
+++ b/gst/geometrictransform/gstmarble.c
@@ -47,6 +47,20 @@
  * his code.
  */
 
+/**
+ * SECTION:element-marble
+ * @see_also: geometrictransform
+ *
+ * Marble is a geometric image transform element. It applies a marbling effect
+ * to the image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! marble ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstmirror.c b/gst/geometrictransform/gstmirror.c
index dceb3c58e643e44303768093695e92015b934f00..df18234d47ab26b1ffdb51af60bda14be8f1bf93 100644 (file)
--- a/gst/geometrictransform/gstmirror.c
+++ b/gst/geometrictransform/gstmirror.c
@@ -41,6 +41,21 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-mirror
+ * @see_also: geometrictransform
+ *
+ * Mirror is a geometric transform element. It splits the image into two halves
+ * and reflects one over each other.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! mirror ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif

diff --git a/gst/geometrictransform/gstperspective.c b/gst/geometrictransform/gstperspective.c
index e9ed2300cd4e07a07ad1cb66fd9532794a9ad308..bafa1fc5dcf734cb1360805585f91cd89d3b234c 100644 (file)
--- a/gst/geometrictransform/gstperspective.c
+++ b/gst/geometrictransform/gstperspective.c
@@ -47,6 +47,20 @@
  * http://docs.oracle.com/cd/E17802_01/products/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/PerspectiveTransform.html
  */
 
+/**
+ * SECTION:element-perspective
+ * @see_also: geometrictransform
+ *
+ * The perspective element applies a 2D perspective transform.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! perspective ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 /* FIXME: suppress warnings for deprecated API such as GValueArray
  * with newer GLib versions (>= 2.31.0)
  *

diff --git a/gst/geometrictransform/gstpinch.c b/gst/geometrictransform/gstpinch.c
index 296b84ab0e89ca91bfe45f28f24938c6894054dd..d68dcd168a0324b2916453ac7d9a17ebf448e18a 100644 (file)
--- a/gst/geometrictransform/gstpinch.c
+++ b/gst/geometrictransform/gstpinch.c
@@ -47,6 +47,19 @@
  * his code.
  */
 
+/**
+ * SECTION:element-pinch
+ * @see_also: geometrictransform
+ *
+ * Pinch applies a 'pinch' geometric transform to the image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! pinch ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstrotate.c b/gst/geometrictransform/gstrotate.c
index 693c89885ddda8c73f67e7caede0795b4941567f..1e03339bf8e8f35b5c49f82f6525a5dce40d7a70 100644 (file)
--- a/gst/geometrictransform/gstrotate.c
+++ b/gst/geometrictransform/gstrotate.c
@@ -47,6 +47,19 @@
  * his code.
  */
 
+/**
+ * SECTION:element-rotate
+ * @see_also: geometrictransform
+ *
+ * The rotate element transforms the image by rotating it by a specified angle.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! rotate angle=0.78 ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstsphere.c b/gst/geometrictransform/gstsphere.c
index a425470f689bc23b03f07a39ad625024e85a8733..5f39a4765ce7729974ca9290ca75366b6a816946 100644 (file)
--- a/gst/geometrictransform/gstsphere.c
+++ b/gst/geometrictransform/gstsphere.c
@@ -47,6 +47,19 @@
  * his code.
  */
 
+/**
+ * SECTION:element-sphere
+ * @see_also: geometrictransform
+ *
+ * The sphere element applies a 'sphere' geometric transform to the image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! sphere ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstsquare.c b/gst/geometrictransform/gstsquare.c
index ba0d2bf4fdf16214116a82bc743bf99d5cbdc6a3..4b044f19403e11487e6f14d8a9f3ced0377683fa 100644 (file)
--- a/gst/geometrictransform/gstsquare.c
+++ b/gst/geometrictransform/gstsquare.c
@@ -41,6 +41,20 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-square
+ * @see_also: geometrictransform
+ *
+ * The square element distorts the center part of the image into a square.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! square zoom=100 ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif

diff --git a/gst/geometrictransform/gststretch.c b/gst/geometrictransform/gststretch.c
index f0c7998fea0801f39a06671c0b1b7befcc2ef061..61eed37f0f76d451644aa84baeb6b2971d7a86e2 100644 (file)
--- a/gst/geometrictransform/gststretch.c
+++ b/gst/geometrictransform/gststretch.c
@@ -41,6 +41,20 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-stretch
+ * @see_also: geometrictransform
+ *
+ * The stretch element stretches the image in a circle around the center point.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! stretch ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif

diff --git a/gst/geometrictransform/gsttunnel.c b/gst/geometrictransform/gsttunnel.c
index a71f0ef0a10e27ada930e7ed63a5dbdb7fbdb8dc..94b6070cc3c51018ecad081950f943ed6485ee68 100644 (file)
--- a/gst/geometrictransform/gsttunnel.c
+++ b/gst/geometrictransform/gsttunnel.c
@@ -41,6 +41,21 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-tunnel
+ * @see_also: geometrictransform
+ *
+ * Tunnel is a geometric image transform element. It applies a light tunnel
+ * effect.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! tunnel ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif

diff --git a/gst/geometrictransform/gsttwirl.c b/gst/geometrictransform/gsttwirl.c
index 33222c859f5b30046a42c395895e153b4f8b1556..962d3ba6d29bd5e4230c8005fcde7c17148ad684 100644 (file)
--- a/gst/geometrictransform/gsttwirl.c
+++ b/gst/geometrictransform/gsttwirl.c
@@ -47,6 +47,19 @@
  * his code.
  */
 
+/**
+ * SECTION:element-twirl
+ * @see_also: geometrictransform
+ *
+ * The twirl element twists the image from the center out.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! twirl ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>

diff --git a/gst/geometrictransform/gstwaterripple.c b/gst/geometrictransform/gstwaterripple.c
index 4daff2a4222e0dd950bf399d1560323e4b17fcba..96af6e8d70f2a3e45443dbe77f58e7048a08074e 100644 (file)
--- a/gst/geometrictransform/gstwaterripple.c
+++ b/gst/geometrictransform/gstwaterripple.c
@@ -47,6 +47,19 @@
  * his code.
  */
 
+/**
+ * SECTION:element-waterripple
+ * @see_also: geometrictransform
+ *
+ * The waterripple element creates a water ripple effect on the image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 -v videotestsrc ! waterripple ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
 
 #ifdef HAVE_CONFIG_H
 #  include <config.h>