Skip to content

[doxygen] Fix some comments in rtservice.h #6894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 2, 2023
Merged

[doxygen] Fix some comments in rtservice.h #6894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 26 additions & 26 deletions include/rtservice.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,27 +128,27 @@ rt_inline unsigned int rt_list_len(const rt_list_t *l)

/**
* rt_list_for_each - iterate over a list
* @pos: the rt_list_t * to use as a loop cursor.
* @head: the head for your list.
* @param pos the rt_list_t * to use as a loop cursor.
* @param head the head for your list.
*/
#define rt_list_for_each(pos, head) \
for (pos = (head)->next; pos != (head); pos = pos->next)

/**
* rt_list_for_each_safe - iterate over a list safe against removal of list entry
* @pos: the rt_list_t * to use as a loop cursor.
* @n: another rt_list_t * to use as temporary storage
* @head: the head for your list.
* @param pos the rt_list_t * to use as a loop cursor.
* @param n another rt_list_t * to use as temporary storage
* @param head the head for your list.
*/
#define rt_list_for_each_safe(pos, n, head) \
for (pos = (head)->next, n = pos->next; pos != (head); \
pos = n, n = pos->next)

/**
* rt_list_for_each_entry - iterate over list of given type
* @pos: the type * to use as a loop cursor.
* @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 cursor.
* @param head the head for your list.
* @param member the name of the list_struct within the struct.
*/
#define rt_list_for_each_entry(pos, head, member) \
for (pos = rt_list_entry((head)->next, typeof(*pos), member); \
Expand All @@ -157,10 +157,10 @@ rt_inline unsigned int rt_list_len(const rt_list_t *l)

/**
* rt_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 cursor.
* @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 cursor.
* @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 rt_list_for_each_entry_safe(pos, n, head, member) \
for (pos = rt_list_entry((head)->next, typeof(*pos), member), \
Expand All @@ -170,9 +170,9 @@ rt_inline unsigned int rt_list_len(const rt_list_t *l)

/**
* rt_list_first_entry - get the first element from a list
* @ptr: the list head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the list_struct within the struct.
* @param ptr the list head to take the element from.
* @param type the type of the struct this is embedded in.
* @param member the name of the list_struct within the struct.
*
* Note, that list is expected to be not empty.
*/
Expand Down Expand Up @@ -267,17 +267,17 @@ rt_inline int rt_slist_isempty(rt_slist_t *l)

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

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

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

/**
* rt_slist_tail_entry - get the tail element from a slist
* @ptr: the slist head to take the element from.
* @type: the type of the struct this is embedded in.
* @member: the name of the slist_struct within the struct.
* @param ptr the slist head to take the element from.
* @param type the type of the struct this is embedded in.
* @param member the name of the slist_struct within the struct.
*
* Note, that slist is expected to be not empty.
*/
Expand Down