From: Luis de Bethencourt <luisbg@osg.samsung.com>
Date: Tue, 15 Dec 2015 15:56:19 +0000 (+0000)
Subject: opencv: add headers with example launch lines
X-Git-Tag: 1.19.3~507^2~7439
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=09882265225851898c0091e2b52b35c5b844c346;p=platform%2Fupstream%2Fgstreamer.git

opencv: add headers with example launch lines

Add description headers for all the OpenCV plugins missing them, so we can
have gst-launch-1.0 example launch lines for all of them.
---

diff --git a/ext/opencv/gstcvdilate.cpp b/ext/opencv/gstcvdilate.cpp
index 9c1479d..bc6b032 100644
--- a/ext/opencv/gstcvdilate.cpp
+++ b/ext/opencv/gstcvdilate.cpp
@@ -41,6 +41,19 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-cvdilate
+ *
+ * Dilates the image with the cvDilate OpenCV function.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc ! cvdilate ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
diff --git a/ext/opencv/gstcvequalizehist.cpp b/ext/opencv/gstcvequalizehist.cpp
index c92497f..ea1db28 100644
--- a/ext/opencv/gstcvequalizehist.cpp
+++ b/ext/opencv/gstcvequalizehist.cpp
@@ -41,6 +41,21 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-cvequalizehist
+ *
+ * Equalizes the histogram of a grayscale image with the cvEqualizeHist OpenCV
+ * function.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc pattern=23 ! cvequalizehist ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
diff --git a/ext/opencv/gstcverode.cpp b/ext/opencv/gstcverode.cpp
index 75e2a1b..39b72be 100644
--- a/ext/opencv/gstcverode.cpp
+++ b/ext/opencv/gstcverode.cpp
@@ -41,6 +41,19 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-cverode
+ *
+ * Erodes the image with the cvErode OpenCV function.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc ! cverode ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
diff --git a/ext/opencv/gstcvlaplace.cpp b/ext/opencv/gstcvlaplace.cpp
index 56b74b2..04cd575 100644
--- a/ext/opencv/gstcvlaplace.cpp
+++ b/ext/opencv/gstcvlaplace.cpp
@@ -41,6 +41,19 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-cvlaplace
+ *
+ * Applies cvLaplace OpenCV function to the image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc ! cvlaplace ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
diff --git a/ext/opencv/gstcvsmooth.cpp b/ext/opencv/gstcvsmooth.cpp
index 1bf3b60..92e070d 100644
--- a/ext/opencv/gstcvsmooth.cpp
+++ b/ext/opencv/gstcvsmooth.cpp
@@ -41,6 +41,19 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-cvsmooth
+ *
+ * Smooths the image using thes cvSmooth OpenCV function.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc ! cvsmooth ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif
diff --git a/ext/opencv/gstcvsobel.cpp b/ext/opencv/gstcvsobel.cpp
index 2623cdc..f1f6750 100644
--- a/ext/opencv/gstcvsobel.cpp
+++ b/ext/opencv/gstcvsobel.cpp
@@ -41,6 +41,19 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-cvsobel
+ *
+ * Applies the cvSobel OpenCV function to the image.
+ *
+ * <refsect2>
+ * <title>Example launch line</title>
+ * |[
+ * gst-launch-1.0 videotestsrc ! cvsobel ! videoconvert ! autovideosink
+ * ]|
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include <config.h>
 #endif