doxify list.h
authorAndre <maan@p133.(none)>
Sat, 6 Jan 2007 14:16:40 +0000 (15:16 +0100)
committerAndre <maan@p133.(none)>
Sat, 6 Jan 2007 14:16:40 +0000 (15:16 +0100)
Also, remove the ifdef LINUX_LIST_H as list.h is included
only once per executable. The only exception was para_server
which included list.h twice. Kill the superfluous include
statement in server.h.

Doxyfile
NEWS
list.h
server.h

index 85cc80e..3b2069a 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -487,7 +487,7 @@ EXCLUDE_SYMLINKS       = NO
 # against the file with absolute path, so to exclude all test directories 
 # for example use the pattern */test/*
 
-EXCLUDE_PATTERNS = list.h *.cmdline.* krell.* gui* SFont* gcc-compat.h rc4.h para.h fade.c config.h sdl_gui.c slider.c dbadm.c
+EXCLUDE_PATTERNS = *.cmdline.* krell.* gui* SFont* gcc-compat.h rc4.h para.h fade.c config.h sdl_gui.c slider.c dbadm.c
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
diff --git a/NEWS b/NEWS
index 6cc5052..ccfdf72 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,9 +1,9 @@
 NEWS
 ====
 
----------------------------------------------
-0.?.? (to be announced) "inductive resonance"
----------------------------------------------
+----------------------------------------------
+0.2.15 (to be announced) "inductive resonance"
+----------------------------------------------
        - para_server: The server.users file is only read once on server
          startup rather than for each connection
        - mp3dec: Fix decoding of corrupt mp3 files
@@ -11,6 +11,7 @@ NEWS
          of audio data not being written under certain circumstances
        - audiod: compute the difference of server time and local time
          correctly
+       - documentation improvements
 
 -------------------------------------------
 0.2.14 (2006-10-15) "transient singularity"
diff --git a/list.h b/list.h
index 486b917..209d870 100644 (file)
--- a/list.h
+++ b/list.h
@@ -6,8 +6,6 @@
  */
 
 #include <stddef.h> /* offsetof */
-#ifndef _LINUX_LIST_H
-#define _LINUX_LIST_H
 
 #define container_of(ptr, type, member) ({                      \
        const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
@@ -21,7 +19,7 @@
 #define LIST_POISON1  ((void *) 0x00100100)
 #define LIST_POISON2  ((void *) 0x00200200)
 
-/*
+/**
  * Simple doubly linked list implementation.
  *
  * Some of the internal functions ("__xxx") are useful when
@@ -30,7 +28,6 @@
  * generate better code by using them directly rather than
  * using the generic single-entry routines.
  */
-
 struct list_head {
        struct list_head *next, *prev;
 };
@@ -58,8 +55,8 @@ static inline void __list_add(struct list_head *new,
 /**
  * add a new entry
  *
- * \param new: new entry to be added
- * \param head: list head to add it after
+ * \param new new entry to be added
+ * \param head list head to add it after
  *
  * Insert a new entry after the specified head.
  * This is good for implementing stacks.
@@ -70,9 +67,10 @@ static inline void para_list_add(struct list_head *new, struct list_head *head)
 }
 
 /**
- * list_add_tail - add a new entry
- * @new: new entry to be added
- * @head: list head to add it before
+ * add a new entry
+ *
+ * \param new new entry to be added
+ * \param head list head to add it before
  *
  * Insert a new entry before the specified head.
  * This is useful for implementing queues.
@@ -96,8 +94,10 @@ static inline void __list_del(struct list_head * prev, struct list_head * next)
 }
 
 /**
- * list_del - deletes entry from list.
- * @entry: the element to delete from the list.
+ * Delete entry from list.
+ *
+ * \param entry the element to delete from the list.
+ *
  * Note: list_empty on entry does not return true after this, the entry is
  * in an undefined state.
  */
@@ -109,9 +109,10 @@ static inline void list_del(struct list_head *entry)
 }
 
 /**
- * list_move - delete from one list and add as another's head
- * @list: the entry to move
- * @head: the head that will precede our entry
+ * delete from one list and add as another's head
+ *
+ * \param list: the entry to move
+ * \param head: the head that will precede our entry
  */
 static inline void list_move(struct list_head *list, struct list_head *head)
 {
@@ -120,8 +121,9 @@ static inline void list_move(struct list_head *list, struct list_head *head)
 }
 
 /**
- * list_empty - tests whether a list is empty
- * @head: the list to test.
+ * test whether a list is empty
+ *
+ * \param head the list to test.
  */
 static inline int list_empty(const struct list_head *head)
 {
@@ -129,29 +131,32 @@ static inline int list_empty(const struct list_head *head)
 }
 
 /**
- * list_entry - get the struct for this entry
- * @ptr:       the &struct list_head pointer.
- * @type:      the type of the struct this is embedded in.
- * @member:    the name of the list_struct within the struct.
+ * get the struct for this entry
+ *
+ * \param ptr the &struct list_head pointer.
+ * \param type the type of the struct this is embedded in.
+ * \param member the name of the list_struct within the struct.
  */
 #define list_entry(ptr, type, member) \
        container_of(ptr, type, member)
 
 /**
- * list_for_each_safe  -       iterate over a list safe against removal of list entry
- * @pos:       the &struct list_head to use as a loop counter.
- * @n:         another &struct list_head to use as temporary storage
- * @head:      the head for your list.
+ * iterate over a list safe against removal of list entry
+ *
+ * \param pos the &struct list_head to use as a loop counter.
+ * \param n another &struct list_head to use as temporary storage
+ * \param head the head for your list.
  */
 #define list_for_each_safe(pos, n, head) \
        for (pos = (head)->next, n = pos->next; pos != (head); \
                pos = n, n = pos->next)
 
 /**
- * list_for_each_entry -       iterate over list of given type
- * @pos:       the type * to use as a loop counter.
- * @head:      the head for your list.
- * @member:    the name of the list_struct within the struct.
+ * iterate over list of given type
+ *
+ * \param pos the type * to use as a loop counter.
+ * \param head the head for your list.
+ * \param member the name of the list_struct within the struct.
  */
 #define list_for_each_entry(pos, head, member)                         \
        for (pos = list_entry((head)->next, typeof(*pos), member);      \
@@ -159,11 +164,12 @@ static inline int list_empty(const struct list_head *head)
             pos = list_entry(pos->member.next, typeof(*pos), member))
 
 /**
- * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
- * @pos:       the type * to use as a loop counter.
- * @n:         another type * to use as temporary storage
- * @head:      the head for your list.
- * @member:    the name of the list_struct within the struct.
+ * iterate over list of given type safe against removal of list entry
+ *
+ * \param pos the type * to use as a loop counter.
+ * \param n another type * to use as temporary storage
+ * \param head the head for your list.
+ * \param member the name of the list_struct within the struct.
  */
 #define list_for_each_entry_safe(pos, n, head, member)                 \
        for (pos = list_entry((head)->next, typeof(*pos), member),      \
@@ -171,17 +177,14 @@ static inline int list_empty(const struct list_head *head)
             &pos->member != (head);                                    \
             pos = n, n = list_entry(n->member.next, typeof(*n), member))
 /**
- * list_for_each_entry_safe_reverse - iterate backwards over list of given type safe against
- *                                   removal of list entry
- * @pos:       the type * to use as a loop counter.
- * @n:         another type * to use as temporary storage
- * @head:      the head for your list.
- * @member:    the name of the list_struct within the struct.
+ * iterate backwards over list of given type safe against removal of list entry
+ * \param pos the type * to use as a loop counter.
+ * \param n another type * to use as temporary storage
+ * \param head the head for your list.
+ * \param member the name of the list_struct within the struct.
  */
 #define list_for_each_entry_safe_reverse(pos, n, head, member)         \
        for (pos = list_entry((head)->prev, typeof(*pos), member),      \
                n = list_entry(pos->member.prev, typeof(*pos), member); \
             &pos->member != (head);                                    \
             pos = n, n = list_entry(n->member.prev, typeof(*n), member))
-
-#endif /* _LIST_H */
index 1648acf..8bec74f 100644 (file)
--- a/server.h
+++ b/server.h
@@ -19,7 +19,6 @@
 /** \file server.h common server data structures */
 
 #include "para.h"
-#include "list.h"
 #include <openssl/pem.h>
 
 /** size of the selector_info and audio_file info strings of struct misc_meta_data */