[gst-cvs] gstreamer: gstcollectpads: Fix docs about GstCollectData list

[Thiago Sousa Santos]

Module: gstreamer
Branch: master
Commit: ac9bfe25ae5ec4bccb10dce832c124345fe5294f
URL:    http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=ac9bfe25ae5ec4bccb10dce832c124345fe5294f

Author: Thiago Santos <thiago.sousa.santos at collabora.co.uk>
Date:   Thu Aug 12 16:05:35 2010 -0300

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

---

 libs/gst/base/gstcollectpads.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/libs/gst/base/gstcollectpads.h b/libs/gst/base/gstcollectpads.h
index a19ce99..939c2f6 100644
--- 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;