[PATCH] libosmocore[master]: doxygen: linuxlist.h: fix some API doc to use doxygen Qt style

[Neels Hofmeyr]

Review at  https://gerrit.osmocom.org/2984

doxygen: linuxlist.h: fix some API doc to use doxygen Qt style

Change-Id: I9ae25c9bc6b7504402e583a6ce77b037083dcb80
---
M include/osmocom/core/linuxlist.h
1 file changed, 16 insertions(+), 22 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/84/2984/1

diff --git a/include/osmocom/core/linuxlist.h b/include/osmocom/core/linuxlist.h
index 5098c5f..b942188 100644
--- a/include/osmocom/core/linuxlist.h
+++ b/include/osmocom/core/linuxlist.h
@@ -332,35 +332,31 @@
 	     &pos->member != (head); 					\
 	     pos = n, n = llist_entry(n->member.next, typeof(*n), member))
 
-/**
- * llist_for_each_rcu	-	iterate over an rcu-protected llist
- * @pos:	the &struct llist_head to use as a loop counter.
- * @head:	the head for your llist.
+/*! iterate over an rcu-protected llist.
+ * \param pos	the &struct llist_head to use as a loop counter.
+ * \param head	the head for your llist.
  */
 #define llist_for_each_rcu(pos, head) \
 	for (pos = (head)->next, prefetch(pos->next); pos != (head); \
         	pos = pos->next, ({ smp_read_barrier_depends(); 0;}), prefetch(pos->next))
-        	
+
 #define __llist_for_each_rcu(pos, head) \
 	for (pos = (head)->next; pos != (head); \
         	pos = pos->next, ({ smp_read_barrier_depends(); 0;}))
-        	
-/**
- * llist_for_each_safe_rcu	-	iterate over an rcu-protected llist safe
- *					against removal of llist entry
- * @pos:	the &struct llist_head to use as a loop counter.
- * @n:		another &struct llist_head to use as temporary storage
- * @head:	the head for your llist.
+
+/*! iterate over an rcu-protected llist safe against removal of llist entry.
+ * \param pos 	the &struct llist_head to use as a loop counter.
+ * \param n 	another &struct llist_head to use as temporary storage
+ * \param head 	the head for your llist.
  */
 #define llist_for_each_safe_rcu(pos, n, head) \
 	for (pos = (head)->next, n = pos->next; pos != (head); \
 		pos = n, ({ smp_read_barrier_depends(); 0;}), n = pos->next)
 
-/**
- * llist_for_each_entry_rcu	-	iterate over rcu llist of given type
- * @pos:	the type * to use as a loop counter.
- * @head:	the head for your llist.
- * @member:	the name of the llist_struct within the struct.
+/*! iterate over rcu llist of given type.
+ * \param pos	the type * to use as a loop counter.
+ * \param head	the head for your llist.
+ * \param member	the name of the llist_struct within the struct.
  */
 #define llist_for_each_entry_rcu(pos, head, member)			\
 	for (pos = llist_entry((head)->next, typeof(*pos), member),	\
@@ -371,11 +367,9 @@
 		     prefetch(pos->member.next))
 
 
-/**
- * llist_for_each_continue_rcu	-	iterate over an rcu-protected llist 
- *			continuing after existing point.
- * @pos:	the &struct llist_head to use as a loop counter.
- * @head:	the head for your llist.
+/*! iterate over an rcu-protected llist continuing after existing point.
+ * \param pos	the &struct llist_head to use as a loop counter.
+ * \param head	the head for your llist.
  */
 #define llist_for_each_continue_rcu(pos, head) \
 	for ((pos) = (pos)->next, prefetch((pos)->next); (pos) != (head); \

-- 
To view, visit https://gerrit.osmocom.org/2984
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I9ae25c9bc6b7504402e583a6ce77b037083dcb80
Gerrit-PatchSet: 1
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>