streams: Extend GstStreamType documentation

Users shouldn't assume it will be a single value since it's a flag.

diff --git a/gst/gststreams.h b/gst/gststreams.h
index a82d81f575c7d34818f5fbd9b9aa00a95179dfff..2df1c7630e5acaa9af35b1f99f97b64c4e51e99b 100644 (file)
--- 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,