Doc: Documented growing arrays, generic allocators and related things

[libucw.git] / ucw / alloc.h

diff --git a/ucw/alloc.h b/ucw/alloc.h
index 6292471944dccf0d79887c137c52c781166dd825..2c59928385419dcd4337f4aacc81aee36eebba92 100644 (file)
--- a/ucw/alloc.h
+++ b/ucw/alloc.h
@@ -7,6 +7,10 @@
 #ifndef _UCW_ALLOC_H
 #define _UCW_ALLOC_H
 
+/**
+ * This structure describes a generic allocator. It provides pointers
+ * to three functions, which handle the actual (re)allocations.
+ **/
 struct ucw_allocator {
   void * (*alloc)(struct ucw_allocator *alloc, size_t size);
   void * (*realloc)(struct ucw_allocator *alloc, void *ptr, size_t old_size, size_t new_size);
@@ -15,7 +19,18 @@ struct ucw_allocator {
 
 /* alloc-std.c */
 
+/**
+ * [[std]]
+ * This allocator uses xmalloc(), xrealloc() and xfree(). The memory
+ * it allocates is left unitialized.
+ **/
 extern struct ucw_allocator ucw_allocator_std;
+
+/**
+ * [[zeroing]]
+ * This allocator uses xmalloc(), xrealloc() and xfree(). All memory
+ * is zeroed upon allocation.
+ **/
 extern struct ucw_allocator ucw_allocator_zeroed;
 
 #endif