list.h: Fix parameter doc of iterators.

[paraslash.git] / list.h

diff --git a/list.h b/list.h
index 9056f1f7f4c72a048a2dd645bba076baa9d9b667..ddcb69da1e00c4f9b82fc5b35d190b932a0e0709 100644 (file)
--- a/list.h
+++ b/list.h
@@ -125,7 +125,7 @@ static inline int list_is_singular(const struct list_head *head)
 /**
  * Iterate over a list.
  *
- * \param pos A list head pointer which serves as the iterator.
+ * \param pos A struct pointer which serves as the iterator.
  * \param head The head of the list.
  * \param member The name of the list head member within the structure.
  */
@@ -137,8 +137,8 @@ static inline int list_is_singular(const struct list_head *head)
 /**
  * Iterate over list, safe against removal of list entry.
  *
- * \param pos The iterator.
- * \param n A list head pointer which is used as temporary storage.
+ * \param pos The iterator struct pointer.
+ * \param n A second struct pointer which is used as temporary storage.
  * \param head The head of the list.
  * \param member The name of the list head member within the structure.
  */