list.h: Fix parameter doc of iterators.
authorAndre Noll <maan@tuebingen.mpg.de>
Thu, 20 May 2021 18:37:44 +0000 (20:37 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 8 Aug 2021 15:29:18 +0000 (17:29 +0200)
list.h

diff --git a/list.h b/list.h
index 9056f1f..ddcb69d 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.
  */