From: Mathieu Duponchelle <mathieu@centricular.com>
Date: Tue, 5 May 2020 15:39:04 +0000 (+0200)
Subject: glcolorscale: fix documentation
X-Git-Tag: 1.19.3~511^2~640
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1aef6b8fd5792872c45de6c51ed01dd958be0775;p=platform%2Fupstream%2Fgstreamer.git

glcolorscale: fix documentation

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-base/-/merge_requests/653>
---

diff --git a/ext/gl/gstglcolorscale.c b/ext/gl/gstglcolorscale.c
index 74d0168..26fff8e 100644
--- a/ext/gl/gstglcolorscale.c
+++ b/ext/gl/gstglcolorscale.c
@@ -22,21 +22,20 @@
  * SECTION:element-glcolorscale
  * @title: glcolorscale
  *
- * video frame scaling and colorspace conversion.
+ * glcolorscale implements scaling of GL video frames, equivalent to
+ * #videoscale. The initial implementation also performed colorspace
+ * conversion, hence the name of the element, but support has since
+ * been removed. You should use #glcolorconvert for that purpose.
  *
- * ## Scaling and Color space conversion
+ * ## Examples
  *
- * Equivalent to glupload ! gldownload.
+ * ``` shell
+ * gst-launch-1.0 videotestsrc ! video/x-raw, width=640, height=480 ! glupload ! \
+ * glcolorscale ! glcolorconvert ! gldownload ! video/x-raw, width=320, height=240 ! \
+ * autovideosink
+ * ```
  *
- * ## Examples
- * |[
- * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glcolorscale ! ximagesink
- * ]| A pipeline to test colorspace conversion.
- * FBO is required.
-  |[
- * gst-launch-1.0 -v videotestsrc ! video/x-raw, width=640, height=480, format=AYUV ! glcolorscale ! \
- *   video/x-raw, width=320, height=240, format=YV12 ! videoconvert ! autovideosink
- * ]| A pipeline to test hardware scaling and colorspace conversion.
+ * A pipeline to test hardware scaling and colorspace conversion.
  * FBO and GLSL are required.
  *
  */