memory: improve docs

Mention that custom allocator functions can pass whatever they want to the
user_data.
This commit is contained in:
Wim Taymans 2012-06-25 09:32:41 +02:00
parent 3ba43888f4
commit 17022f7ad1

View file

@ -247,7 +247,9 @@ struct _GstAllocationParams {
* be filled with 0 if @params flags contains #GST_MEMORY_FLAG_ZERO_PREFIXED and
* #GST_MEMORY_FLAG_ZERO_PADDED respectively.
*
* @user_data is the data that was used when creating @allocator.
* @user_data is extra data passed to this function. The default
* gst_allocator_alloc() passes the user_data that was used when creating
* @allocator.
*
* Returns: a newly allocated #GstMemory. Free with gst_memory_unref()
*/