gstcollectpads: Fix docs about GstCollectData list

Add to the docs the fact that is only safe to iterate
GstCollectPad's data list inside the collected callback.

Fixes #610366

diff --git a/libs/gst/base/gstcollectpads.h b/libs/gst/base/gstcollectpads.h
index a19ce997eb395a465ac0e066f67a1c2d8fc59112..939c2f63a3b1e0c73135e95f729157e6ed23aebe 100644 (file)
--- a/libs/gst/base/gstcollectpads.h
+++ b/libs/gst/base/gstcollectpads.h
@@ -130,8 +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.
+ * Note that @data is only reliable for iterating the list of #GstCollectData
+ * when inside the #GstCollectPadsFunction callback.
  */
 struct _GstCollectPads {
   GstObject      object;