From: Olivier Crête <olivier.crete@collabora.com>
Date: Thu, 16 Jul 2020 20:34:05 +0000 (-0400)
Subject: pad: More explicitly explain how to post errors on GST_FLOW_ERROR
X-Git-Tag: 1.19.3~763
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=90530bdb28321968c30852761c4d74f9c6a337f9;p=platform%2Fupstream%2Fgstreamer.git

pad: More explicitly explain how to post errors on GST_FLOW_ERROR

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/568>
---

diff --git a/gst/gstpad.h b/gst/gstpad.h
index 1b4f29f..8cc896d 100644
--- a/gst/gstpad.h
+++ b/gst/gstpad.h
@@ -137,8 +137,8 @@ typedef enum {
  * @GST_FLOW_EOS:                Pad is EOS.
  * @GST_FLOW_NOT_NEGOTIATED:	 Pad is not negotiated.
  * @GST_FLOW_ERROR:		 Some (fatal) error occurred. Element generating
- *                               this error should post an error message with more
- *                               details.
+ *                               this error should post an error message using
+ *                               GST_ELEMENT_ERROR() with more details.
  * @GST_FLOW_NOT_SUPPORTED:	 This operation is not supported.
  * @GST_FLOW_CUSTOM_SUCCESS:	 Elements can use values starting from
  *                               this (and higher) to define custom success