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
This commit is contained in:
Thiago Santos 2010-08-12 16:05:35 -03:00
parent 9eaf20631c
commit ac9bfe25ae

View file

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