fixed doxygen docu
authorMichael Beck <beck@ipd.info.uni-karlsruhe.de>
Fri, 1 Jul 2005 09:13:16 +0000 (09:13 +0000)
committerMichael Beck <beck@ipd.info.uni-karlsruhe.de>
Fri, 1 Jul 2005 09:13:16 +0000 (09:13 +0000)
[r6165]

ir/adt/list.h
ir/adt/pdeq.h
ir/tv/tv.h

index 9664906..201ed7f 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   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   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)
 {
@@ -175,8 +177,8 @@ 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.
+ * @param list   the new list to add.
+ * @param head   the place to add it in the first list.
  *
  * The list at @list is reinitialised
  */
@@ -191,17 +193,17 @@ 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); \
@@ -209,8 +211,8 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * __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,8 +224,8 @@ 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); \
@@ -231,9 +233,9 @@ static INLINE void list_splice_init(struct list_head *list,
 
 /**
  * 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 +243,9 @@ 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 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 +254,9 @@ 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 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,10 @@ 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 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),      \
index 583fda8..e0ff636 100644 (file)
@@ -76,7 +76,7 @@ int pdeq_empty(pdeq *dq);
  * Returns non-zero if a double ended pointer list
  * contains a pointer x.
  *
- * @param dp  The list.
+ * @param dq  The list.
  * @param x   The pointer to be searched for.
  */
 int pdeq_contains(pdeq *dq, const void *x);
@@ -100,7 +100,7 @@ void *pdeq_search(pdeq *qp, cmp_fun cmp, const void *key);
  * Convert the double ended pointer list into a linear array beginning from
  * left, the first element in the linear array will be the left one.
  *
- * @param dq   The list.
+ * @param qp   The list.
  * @param dst  A pointer to a pointer array with must be at least
  *             pdeq_len(dq) * sizeof(void *)
  *
@@ -112,7 +112,7 @@ void **pdeq_copyl(pdeq *qp, const void **dst);
  * Convert the double ended pointer list into a linear array beginning from
  * right, the first element in the linear array will be the right one.
  *
- * @param dq   The list.
+ * @param qp   The list.
  * @param dst  A pointer to a pointer array with must be at least
  *             pdeq_len(dq) * sizeof(void *)
  *
index 3fabedd..32f28af 100644 (file)
@@ -385,7 +385,7 @@ pn_Cmp tarval_cmp(tarval *a, tarval *b);
  *    FIRM documentation for conversion rules
  *    mode_is_smaller defined in irmode.h
  */
-tarval *tarval_convert_to(tarval *src, ir_mode *m);
+tarval *tarval_convert_to(tarval *src, ir_mode *mode);
 
 /*
  * These function implement basic computations representable as opcodes