more doxy -> .h

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@58436 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/include/eina_mempool.h b/src/include/eina_mempool.h
index a8c3155..e30efd2 100644 (file)
--- a/src/include/eina_mempool.h
+++ b/src/include/eina_mempool.h
@@ -23,6 +23,43 @@
 #include "eina_error.h"
 #include "eina_module.h"
 
+
+/**
+ * @addtogroup Eina_Memory_Pool_Group Memory Pool
+ *
+ * @brief These functions provide memory pool management.
+ *
+ * Several mempool are available:
+ *
+ * @li @c buddy: It uses the
+ * <a href="http://en.wikipedia.org/wiki/Buddy_memory_allocation">"buddy
+ * allocator" algorithm</a> but the Eina implementation differs in the
+ * sense that the chunk information is not stored on the chunk itself,
+ * but on another memory area. This is useful for cases where the
+ * memory to manage might be slower to access, or limited (like video
+ * memory).
+ * @li @c chained_pool: It is the default one. It allocates a big
+ * chunk of memory with malloc() and split the result in chunks of the
+ * requested size that are pushed inside a stack. When requested, it
+ * takes this pointer from the stack to give them to whoever wants
+ * them.
+ * @li @c ememoa_fixed and @c ememoa_unknown: experimental allocators
+ * which could be useful when a fixed amount of memory is needed.
+ * @li @c fixed_bitmap: It allocates with malloc) 32* the requested
+ * size and push the pool pointer in an rbtree. To find empty space in
+ * a pool, it will just search for the first bit set in an int (32
+ * bits). Then, when a pointer is freed, it will do a search inside
+ * the rbtree.
+ * @li @c pass_through: it just call malloc() and free(). It may be
+ * faster on some computers than using our own allocators (like having
+ * a huge L2 cache, over 4MB).
+ * @li @c one_big: It call just one time malloc for the requested number
+ * of items. Usefull when you know in advance how many object of some
+ * type will live during the life of the mempool.
+ *
+ * @{
+ */
+
 /**
  * @addtogroup Eina_Tools_Group Tools
  *
@@ -74,4 +111,8 @@ EAPI unsigned int   eina_mempool_alignof(unsigned int size);
  * @}
  */
 
+/**
+ * @}
+ */
+
 #endif /* EINA_MEMPOOL_H_ */

diff --git a/src/lib/eina_mempool.c b/src/lib/eina_mempool.c
index 9d25e8a..7e30264 100644 (file)
--- a/src/lib/eina_mempool.c
+++ b/src/lib/eina_mempool.c
@@ -287,42 +287,6 @@ eina_mempool_shutdown(void)
 *                                   API                                      *
 *============================================================================*/
 
-/**
- * @addtogroup Eina_Memory_Pool_Group Memory Pool
- *
- * @brief These functions provide memory pool management.
- *
- * Several mempool are available:
- *
- * @li @c buddy: It uses the
- * <a href="http://en.wikipedia.org/wiki/Buddy_memory_allocation">"buddy
- * allocator" algorithm</a> but the Eina implementation differs in the
- * sense that the chunk information is not stored on the chunk itself,
- * but on another memory area. This is useful for cases where the
- * memory to manage might be slower to access, or limited (like video
- * memory).
- * @li @c chained_pool: It is the default one. It allocates a big
- * chunk of memory with malloc() and split the result in chunks of the
- * requested size that are pushed inside a stack. When requested, it
- * takes this pointer from the stack to give them to whoever wants
- * them.
- * @li @c ememoa_fixed and @c ememoa_unknown: experimental allocators
- * which could be useful when a fixed amount of memory is needed.
- * @li @c fixed_bitmap: It allocates with malloc) 32* the requested
- * size and push the pool pointer in an rbtree. To find empty space in
- * a pool, it will just search for the first bit set in an int (32
- * bits). Then, when a pointer is freed, it will do a search inside
- * the rbtree.
- * @li @c pass_through: it just call malloc() and free(). It may be
- * faster on some computers than using our own allocators (like having
- * a huge L2 cache, over 4MB).
- * @li @c one_big: It call just one time malloc for the requested number
- * of items. Usefull when you know in advance how many object of some
- * type will live during the life of the mempool.
- *
- * @{
- */
-
 EAPI Eina_Mempool *
 eina_mempool_add(const char *name,
                  const char *context,
@@ -393,7 +357,3 @@ eina_mempool_alignof(unsigned int size)
 
    return ((size / align) + 1) * align;
 }
-
-/**
- * @}
- */