X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Falloc.h;h=668c707cc7ad455364e21e76e104c34de8376164;hb=0eb6d8317cdbdb28663ff779d31684b3c7a47274;hp=6292471944dccf0d79887c137c52c781166dd825;hpb=a1fd264e82dc24343c8129a3e8e611f976f262c9;p=libucw.git

diff --git a/ucw/alloc.h b/ucw/alloc.h
index 62924719..668c707c 100644
--- 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 <<basics:xmalloc()>>, <<basics:xrealloc()>> and <<basics:xfree()>>. The memory
+ * it allocates is left unitialized.
+ **/
 extern struct ucw_allocator ucw_allocator_std;
+
+/**
+ * [[zeroing]]
+ * This allocator uses <<basics:xmalloc()>>, <<basics:xrealloc()>> and <<basics:xfree()>>. All memory
+ * is zeroed upon allocation.
+ **/
 extern struct ucw_allocator ucw_allocator_zeroed;
 
 #endif