Skip to content

Commit 4d6ceff

Browse files
tuduwebmysterywolf
authored andcommitted
[doxygen] Fix some comments in rtservice.h
1 parent a9b9bf0 commit 4d6ceff

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

include/rtservice.h

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -128,27 +128,27 @@ rt_inline unsigned int rt_list_len(const rt_list_t *l)
128128

129129
/**
130130
* rt_list_for_each - iterate over a list
131-
* @pos: the rt_list_t * to use as a loop cursor.
132-
* @head: the head for your list.
131+
* @param pos the rt_list_t * to use as a loop cursor.
132+
* @param head the head for your list.
133133
*/
134134
#define rt_list_for_each(pos, head) \
135135
for (pos = (head)->next; pos != (head); pos = pos->next)
136136

137137
/**
138138
* rt_list_for_each_safe - iterate over a list safe against removal of list entry
139-
* @pos: the rt_list_t * to use as a loop cursor.
140-
* @n: another rt_list_t * to use as temporary storage
141-
* @head: the head for your list.
139+
* @param pos the rt_list_t * to use as a loop cursor.
140+
* @param n another rt_list_t * to use as temporary storage
141+
* @param head the head for your list.
142142
*/
143143
#define rt_list_for_each_safe(pos, n, head) \
144144
for (pos = (head)->next, n = pos->next; pos != (head); \
145145
pos = n, n = pos->next)
146146

147147
/**
148148
* rt_list_for_each_entry - iterate over list of given type
149-
* @pos: the type * to use as a loop cursor.
150-
* @head: the head for your list.
151-
* @member: the name of the list_struct within the struct.
149+
* @param pos the type * to use as a loop cursor.
150+
* @param head the head for your list.
151+
* @param member the name of the list_struct within the struct.
152152
*/
153153
#define rt_list_for_each_entry(pos, head, member) \
154154
for (pos = rt_list_entry((head)->next, typeof(*pos), member); \
@@ -157,10 +157,10 @@ rt_inline unsigned int rt_list_len(const rt_list_t *l)
157157

158158
/**
159159
* rt_list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
160-
* @pos: the type * to use as a loop cursor.
161-
* @n: another type * to use as temporary storage
162-
* @head: the head for your list.
163-
* @member: the name of the list_struct within the struct.
160+
* @param pos the type * to use as a loop cursor.
161+
* @param n another type * to use as temporary storage
162+
* @param head the head for your list.
163+
* @param member the name of the list_struct within the struct.
164164
*/
165165
#define rt_list_for_each_entry_safe(pos, n, head, member) \
166166
for (pos = rt_list_entry((head)->next, typeof(*pos), member), \
@@ -170,9 +170,9 @@ rt_inline unsigned int rt_list_len(const rt_list_t *l)
170170

171171
/**
172172
* rt_list_first_entry - get the first element from a list
173-
* @ptr: the list head to take the element from.
174-
* @type: the type of the struct this is embedded in.
175-
* @member: the name of the list_struct within the struct.
173+
* @param ptr the list head to take the element from.
174+
* @param type the type of the struct this is embedded in.
175+
* @param member the name of the list_struct within the struct.
176176
*
177177
* Note, that list is expected to be not empty.
178178
*/
@@ -267,17 +267,17 @@ rt_inline int rt_slist_isempty(rt_slist_t *l)
267267

268268
/**
269269
* rt_slist_for_each - iterate over a single list
270-
* @pos: the rt_slist_t * to use as a loop cursor.
271-
* @head: the head for your single list.
270+
* @param pos the rt_slist_t * to use as a loop cursor.
271+
* @param head the head for your single list.
272272
*/
273273
#define rt_slist_for_each(pos, head) \
274274
for (pos = (head)->next; pos != RT_NULL; pos = pos->next)
275275

276276
/**
277277
* rt_slist_for_each_entry - iterate over single list of given type
278-
* @pos: the type * to use as a loop cursor.
279-
* @head: the head for your single list.
280-
* @member: the name of the list_struct within the struct.
278+
* @param pos the type * to use as a loop cursor.
279+
* @param head the head for your single list.
280+
* @param member the name of the list_struct within the struct.
281281
*/
282282
#define rt_slist_for_each_entry(pos, head, member) \
283283
for (pos = rt_slist_entry((head)->next, typeof(*pos), member); \
@@ -286,9 +286,9 @@ rt_inline int rt_slist_isempty(rt_slist_t *l)
286286

287287
/**
288288
* rt_slist_first_entry - get the first element from a slist
289-
* @ptr: the slist head to take the element from.
290-
* @type: the type of the struct this is embedded in.
291-
* @member: the name of the slist_struct within the struct.
289+
* @param ptr the slist head to take the element from.
290+
* @param type the type of the struct this is embedded in.
291+
* @param member the name of the slist_struct within the struct.
292292
*
293293
* Note, that slist is expected to be not empty.
294294
*/
@@ -297,9 +297,9 @@ rt_inline int rt_slist_isempty(rt_slist_t *l)
297297

298298
/**
299299
* rt_slist_tail_entry - get the tail element from a slist
300-
* @ptr: the slist head to take the element from.
301-
* @type: the type of the struct this is embedded in.
302-
* @member: the name of the slist_struct within the struct.
300+
* @param ptr the slist head to take the element from.
301+
* @param type the type of the struct this is embedded in.
302+
* @param member the name of the slist_struct within the struct.
303303
*
304304
* Note, that slist is expected to be not empty.
305305
*/

0 commit comments

Comments
 (0)