From 5750f19712e639fc6aa9b64ef0b033b2fbe060c4 Mon Sep 17 00:00:00 2001
From: Wim Taymans <wim.taymans@collabora.co.uk>
Date: Mon, 9 Jul 2012 16:22:04 +0200
Subject: [PATCH] docs: fix docs a little more

---
 docs/gst/gstreamer-sections.txt | 71 ++++++++++++++++++---------------
 gst/gstallocator.h              | 35 ++--------------
 2 files changed, 43 insertions(+), 63 deletions(-)

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 467a66f811..fef1fe9b2c 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1284,13 +1284,50 @@ gst_iterator_item_get_type
 gst_iterator_result_get_type
 </SECTION>
 
+<SECTION>
+<FILE>gstallocator</FILE>
+<TITLE>GstAllocator</TITLE>
+gst_memory_alignment
+
+GstAllocator
+GstAllocatorFlags
+GstAllocationParams
+
+GST_ALLOCATOR_SYSMEM
+gst_allocator_find
+gst_allocator_register
+gst_allocator_set_default
+
+gst_allocation_params_init
+gst_allocation_params_copy
+gst_allocation_params_free
+
+gst_allocator_alloc
+gst_allocator_free
+
+gst_memory_new_wrapped
+
+<SUBSECTION Standard>
+GST_ALLOCATOR
+GST_ALLOCATOR_CAST
+GST_ALLOCATOR_CLASS
+GST_ALLOCATOR_GET_CLASS
+GST_IS_ALLOCATOR
+GST_IS_ALLOCATOR_CLASS
+GstAllocatorClass
+<SUBSECTION Private>
+GST_TYPE_ALLOCATOR_FLAGS
+GstAllocatorPrivate
+GST_TYPE_ALLOCATION_PARAMS
+gst_allocation_params_get_type
+GST_TYPE_ALLOCATOR
+gst_allocator_get_type
+</SECTION>
 
 <SECTION>
 <FILE>gstmemory</FILE>
 <TITLE>GstMemory</TITLE>
 
-gst_memory_alignment
-
 GstMemoryFlags
 GST_MEMORY_FLAGS
 GST_MEMORY_FLAG_IS_SET
@@ -1307,38 +1344,12 @@ GstMapInfo
 GST_MAP_INFO_INIT
 GST_MAP_READWRITE
 
-GstAllocationParams
-
-GstAllocatorAllocFunction
 GstMemoryMapFunction
 GstMemoryUnmapFunction
-GstMemoryFreeFunction
 GstMemoryCopyFunction
 GstMemoryShareFunction
 GstMemoryIsSpanFunction
 
-GstMemoryInfo
-
-GstAllocator
-
-gst_allocator_new
-gst_allocator_get_memory_type
-gst_allocator_ref
-gst_allocator_unref
-
-GST_ALLOCATOR_SYSMEM
-gst_allocator_find
-gst_allocator_register
-gst_allocator_set_default
-
-gst_allocation_params_init
-gst_allocation_params_copy
-gst_allocation_params_free
-
-gst_allocator_alloc
-
-gst_memory_new_wrapped
-
 gst_memory_ref
 gst_memory_unref
 
@@ -1365,10 +1376,6 @@ GST_TYPE_MAP_FLAGS
 gst_map_flags_get_type
 GST_TYPE_MEMORY_FLAGS
 gst_memory_flags_get_type
-GST_TYPE_ALLOCATION_PARAMS
-gst_allocation_params_get_type
-GST_TYPE_ALLOCATOR
-gst_allocator_get_type
 </SECTION>
 
 <SECTION>
diff --git a/gst/gstallocator.h b/gst/gstallocator.h
index 1ef471f192..8a2ad36b56 100644
--- a/gst/gstallocator.h
+++ b/gst/gstallocator.h
@@ -77,35 +77,9 @@ struct _GstAllocationParams {
   gpointer _gst_reserved[GST_PADDING];
 };
 
-#if 0
-/**
- * GstAllocatorAllocFunction:
- * @allocator: a #GstAllocator
- * @size: the size
- * @params: allocator params
- * @user_data: user data
- *
- * Allocate a new #GstMemory from @allocator that can hold at least @size
- * bytes (+ padding) and is aligned to (@align + 1) bytes.
- *
- * The offset and size of the memory should be set and the prefix/padding must
- * be filled with 0 if @params flags contains #GST_MEMORY_FLAG_ZERO_PREFIXED and
- * #GST_MEMORY_FLAG_ZERO_PADDED respectively.
- *
- * @user_data is extra data passed to this function. The default
- * gst_allocator_alloc() passes the NULL but other implementations could pass
- * custom data.
- *
- * Returns: a newly allocated #GstMemory. Free with gst_memory_unref()
- */
-typedef GstMemory *  (*GstAllocatorAllocFunction)  (GstAllocator *allocator,
-                                                    gsize size, GstAllocationParams *params,
-                                                    gpointer user_data);
-#endif
-
 /**
  * GstAllocatorFlags:
- * @GST_ALLOCATOR_CUSTOM_ALLOC: The allocator has a custom alloc function.
+ * @GST_ALLOCATOR_FLAG_CUSTOM_ALLOC: The allocator has a custom alloc function.
  * @GST_ALLOCATOR_FLAG_LAST: first flag that can be used for custom purposes
  *
  * Flags for allocators.
@@ -118,11 +92,10 @@ typedef enum {
 
 /**
  * GstAllocator:
- * @mini_object: parent structure
+ * @object: parent structure
  * @mem_type: the memory type this allocator provides
  * @mem_map: the implementation of the GstMemoryMapFunction
  * @mem_unmap: the implementation of the GstMemoryUnmapFunction
- * @mem_free: the implementation of the GstMemoryFreeFunction
  * @mem_copy: the implementation of the GstMemoryCopyFunction
  * @mem_share: the implementation of the GstMemoryShareFunction
  * @mem_is_span: the implementation of the GstMemoryIsSpanFunction
@@ -142,9 +115,9 @@ struct _GstAllocator
   GstMemoryShareFunction    mem_share;
   GstMemoryIsSpanFunction   mem_is_span;
 
+  /*< private >*/
   gpointer _gst_reserved[GST_PADDING];
 
-  /*< private >*/
   GstAllocatorPrivate *priv;
 };
 
@@ -175,7 +148,7 @@ void           gst_allocation_params_free    (GstAllocationParams *params);
 /* allocating memory blocks */
 GstMemory *    gst_allocator_alloc           (GstAllocator * allocator, gsize size,
                                               GstAllocationParams *params);
-void           gst_allocator_free            (GstAllocator * allocator, GstMemory *mem);
+void           gst_allocator_free            (GstAllocator * allocator, GstMemory *memory);
 
 GstMemory *    gst_memory_new_wrapped  (GstMemoryFlags flags, gpointer data, gsize maxsize,
                                         gsize offset, gsize size, gpointer user_data,