X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=list.h;h=ba6211ba191395e40fd63d526ab9ddacc2b7f697;hb=48107fb4b9ad286edc38bc336a8703eea7048f88;hp=209d8701c9c6a975972ed3a6a98c557f3554ddd8;hpb=af353ccce9f889507bdebad7d20854e236e89d54;p=paraslash.git

diff --git a/list.h b/list.h
index 209d8701..ba6211ba 100644
--- a/list.h
+++ b/list.h
@@ -5,18 +5,23 @@
  *
  */
 
+/** \file list.h doubly linked list implementation */
+
 #include <stddef.h> /* offsetof */
 
 #define container_of(ptr, type, member) ({                      \
 	const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 	(type *)( (char *)__mptr - offsetof(type,member) );})
 
-/*
- * These are non-NULL pointers that will result in page faults
- * under normal circumstances, used to verify that nobody uses
- * non-initialized list entries.
+/**
+ * Non-NULL pointers that will result in page faults under normal
+ * circumstances, used to verify that nobody uses non-initialized list entries.
+ * Used for poisoning the \a next pointer of struct list_head.
  */
 #define LIST_POISON1  ((void *) 0x00100100)
+/** Non-null pointer, used for poisoning the \a prev pointer of struct
+ * list_head
+ */
 #define LIST_POISON2  ((void *) 0x00200200)
 
 /**