From 71a2bdeaf779c6c7d0cf390e6881c76297d6acc8 Mon Sep 17 00:00:00 2001
From: Edward Hervey <edward@centricular.com>
Date: Thu, 13 Oct 2016 12:03:20 +0200
Subject: [PATCH] streams: Extend GstStreamType documentation

Users shouldn't assume it will be a single value since it's a flag.
---
 gst/gststreams.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/gst/gststreams.h b/gst/gststreams.h
index a82d81f575..2df1c7630e 100644
--- a/gst/gststreams.h
+++ b/gst/gststreams.h
@@ -48,6 +48,10 @@ G_BEGIN_DECLS
  *
  * #GstStreamType describes a high level classification set for
  * flows of data in #GstStream objects.
+ *
+ * Note that this is a flag, and therefore users should not assume it
+ * will be a single value. Do not use the equality operator for checking
+ * whether a stream is of a certain type.
  */
 typedef enum {
   GST_STREAM_TYPE_UNKNOWN   = 1 << 0,