collectpads: Improve docs about 'data' attribute
authorThiago Santos <thiago.sousa.santos@collabora.co.uk>
Thu, 18 Feb 2010 14:52:28 +0000 (11:52 -0300)
committerThiago Santos <thiago.sousa.santos@collabora.co.uk>
Thu, 18 Feb 2010 20:00:05 +0000 (17:00 -0300)
Adds a reminder to 'data' attribute doc

Fixes #610366

libs/gst/base/gstcollectpads.h

index f5ced28..a19ce99 100644 (file)
@@ -130,6 +130,8 @@ typedef GstFlowReturn (*GstCollectPadsFunction) (GstCollectPads *pads, gpointer
  * @data: #GList of #GstCollectData managed by this #GstCollectPads.
  *
  * Collectpads object.
+ * Note that @data doesn't contain the complete #GstCollectData list
+ * at all times and should not be used for iterating them.
  */
 struct _GstCollectPads {
   GstObject      object;