summaryrefslogtreecommitdiff
path: root/gst/geometrictransform/gstcircle.c
diff options
context:
space:
mode:
authorLuis de Bethencourt <luisbg@osg.samsung.com>2015-12-15 11:59:00 +0000
committerLuis de Bethencourt <luisbg@osg.samsung.com>2015-12-15 12:01:00 +0000
commitef53eabee3f5323be3b0dcf11d3672752900ef0e (patch)
treea39e0c9fd09695cddf5f01882627d52c08655189 /gst/geometrictransform/gstcircle.c
parent7c42ba97d7ca394c0a2db097a65d3a895f6b5605 (diff)
downloadgstreamer-plugins-bad-ef53eabee3f5323be3b0dcf11d3672752900ef0e.tar.gz
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.
Diffstat (limited to 'gst/geometrictransform/gstcircle.c')
-rw-r--r--gst/geometrictransform/gstcircle.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/gst/geometrictransform/gstcircle.c b/gst/geometrictransform/gstcircle.c
index cf6ab01d9..da4f48b0d 100644
--- 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>