[PATCH] Include: Linux: rculist_nulls: Add docbook comment headers
From: madhuparnabhowmik04
Date: Wed Dec 04 2019 - 07:04:18 EST
From: Madhuparna Bhowmik <madhuparnabhowmik04@xxxxxxxxx>
This patch adds docbook comment headers for hlist_nulls_first_rcu
and hlist_nulls_next_rcu in rculist_nulls.h.
Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@xxxxxxxxx>
---
include/linux/rculist_nulls.h | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/include/linux/rculist_nulls.h b/include/linux/rculist_nulls.h
index 517a06f36c7a..d796ef18ec52 100644
--- a/include/linux/rculist_nulls.h
+++ b/include/linux/rculist_nulls.h
@@ -38,9 +38,17 @@ static inline void hlist_nulls_del_init_rcu(struct hlist_nulls_node *n)
}
}
+/**
+ * hlist_nulls_first_rcu - returns the first element of the hash list.
+ * @head: the head for your list.
+ */
#define hlist_nulls_first_rcu(head) \
(*((struct hlist_nulls_node __rcu __force **)&(head)->first))
+/**
+ * hlist_nulls_next_rcu - returns the element of the list next to @node.
+ * @node: Element of the list.
+ */
#define hlist_nulls_next_rcu(node) \
(*((struct hlist_nulls_node __rcu __force **)&(node)->next))
--
2.17.1