*** empty log message ***
[libfirm] / ir / adt / list.h
index 9664906..8713e36 100644 (file)
@@ -55,8 +55,8 @@ static INLINE void __list_add(struct list_head *new_node,
 
 /**
  * list_add - add a new entry
- * @new: new entry to be added
- * @head: list head to add it after
+ * @param new_node   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.
@@ -68,8 +68,8 @@ static INLINE void list_add(struct list_head *new_node, struct list_head *head)
 
 /**
  * list_add_tail - add a new entry
- * @new: new entry to be added
- * @head: list head to add it before
+ * @param new_node   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.
@@ -94,9 +94,11 @@ 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.
- * Note: list_empty on entry does not return true after this, the entry is
- * in an undefined state.
+ * @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.
  */
 static INLINE void list_del(struct list_head *entry)
 {
@@ -108,7 +110,7 @@ static INLINE void list_del(struct list_head *entry)
 
 /**
  * list_del_init - deletes entry from list and reinitialize it.
- * @entry: the element to delete from the list.
+ * @param entry   the element to delete from the list.
  */
 static INLINE void list_del_init(struct list_head *entry)
 {
@@ -118,8 +120,8 @@ static INLINE void list_del_init(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
+ * @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)
 {
@@ -129,8 +131,8 @@ static INLINE void list_move(struct list_head *list, struct list_head *head)
 
 /**
  * list_move_tail - delete from one list and add as another's tail
- * @list: the entry to move
- * @head: the head that will follow our entry
+ * @param list   the entry to move
+ * @param head   the head that will follow our entry
  */
 static INLINE void list_move_tail(struct list_head *list,
                                  struct list_head *head)
@@ -141,7 +143,7 @@ static INLINE void list_move_tail(struct list_head *list,
 
 /**
  * list_empty - tests whether a list is empty
- * @head: the list to test.
+ * @param head   the list to test.
  */
 static INLINE int list_empty(const struct list_head *head)
 {
@@ -164,8 +166,8 @@ static INLINE void __list_splice(struct list_head *list,
 
 /**
  * list_splice - join two lists
- * @list: the new list to add.
- * @head: the place to add it in the first list.
+ * @param list   the new list to add.
+ * @param head   the place to add it in the first list.
  */
 static INLINE void list_splice(struct list_head *list, struct list_head *head)
 {
@@ -174,11 +176,11 @@ static INLINE void list_splice(struct list_head *list, struct list_head *head)
 }
 
 /**
- * list_splice_init - join two lists and reinitialise the emptied list.
- * @list: the new list to add.
- * @head: the place to add it in the first list.
+ * list_splice_init - join two lists and reinitialize the emptied list.
+ * @param list   the new list to add.
+ * @param head   the place to add it in the first list.
  *
- * The list at @list is reinitialised
+ * The list at list is reinitialized
  */
 static INLINE void list_splice_init(struct list_head *list,
                                    struct list_head *head)
@@ -191,26 +193,25 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * 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.
+ * @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) \
        _list_container_of(ptr, type, member)
 
 /**
  * list_for_each       -       iterate over a list
- * @pos:       the &struct list_head to use as a loop counter.
- * @head:      the head for your list.
+ * @param pos  the &struct list_head to use as a loop counter.
+ * @param head the head for your list.
  */
 #define list_for_each(pos, head) \
-       for (pos = (head)->next, (pos->next); pos != (head); \
-               pos = pos->next, (pos->next))
+       for (pos = (head)->next; pos != (head); pos = pos->next)
 
 /**
  * __list_for_each     -       iterate over a list
- * @pos:       the &struct list_head to use as a loop counter.
- * @head:      the head for your list.
+ * @param pos  the &struct list_head to use as a loop counter.
+ * @param head the head for your list.
  *
  * This variant differs from list_for_each() in that it's the
  * simplest possible list iteration code, no ing is done.
@@ -222,18 +223,17 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_prev  -       iterate over a list backwards
- * @pos:       the &struct list_head to use as a loop counter.
- * @head:      the head for your list.
+ * @param pos  the &struct list_head to use as a loop counter.
+ * @param head the head for your list.
  */
 #define list_for_each_prev(pos, head) \
-       for (pos = (head)->prev, (pos->prev); pos != (head); \
-               pos = pos->prev, (pos->prev))
+       for (pos = (head)->prev; pos != (head); pos = pos->prev)
 
 /**
  * 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.
+ * @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); \
@@ -241,9 +241,10 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * 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.
+ * @param type    the type of the struct where the listhead is embedded in
+ * @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(type, pos, head, member)                           \
        for (pos = list_entry((head)->next, type, member);      \
@@ -252,9 +253,10 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * list_for_each_entry_reverse - iterate backwards 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.
+ * @param type    the type of the struct where the listhead is embedded in
+ * @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_reverse(type, pos, head, member)                   \
        for (pos = list_entry((head)->prev, type, member);      \
@@ -264,10 +266,11 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * 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.
+ * @param type    the type of the struct where the listhead is embedded in
+ * @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(type, pos, n, head, member)                   \
        for (pos = list_entry((head)->next, type, member),      \