gst/gstbuffer.h: Document the free_func.

Original commit message from CVS:
* gst/gstbuffer.h:
Document the free_func.

diff --git a/ChangeLog b/ChangeLog
index 9909b57..73b5dcd 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-11-18  Wim Taymans  <wim.taymans@collabora.co.uk>
+
+       * gst/gstbuffer.h:
+       Document the free_func.
+
 2008-11-17  Sebastian Dröge  <sebastian.droege@collabora.co.uk>
 
        * libs/gst/controller/gstinterpolation.c:

diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h
index ca5d10c..4b2c3f8 100644 (file)
--- a/gst/gstbuffer.h
+++ b/gst/gstbuffer.h
@@ -247,7 +247,9 @@ typedef enum {
  * @offset_end: the last offset contained in this buffer. It has the same 
  *     format as @offset.
  * @malloc_data: a pointer to the allocated memory associated with this buffer.
- *     When the buffer is freed, this data will freed with g_free().
+ *     When the buffer is freed, this data will freed with @free_func.
+ * @free_func: a custom function that will be called with @malloc_data, defaults
+ *     to g_free(). Since 0.10.22.
  *
  * The structure of a #GstBuffer. Use the associated macros to access the public
  * variables.
@@ -273,7 +275,7 @@ struct _GstBuffer {
 
   guint8                *malloc_data;
 
-  GFreeFunc            free_func;
+  GFreeFunc              free_func;
 
   /*< private >*/
   gpointer _gst_reserved[GST_PADDING - 1];