Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

kernel-doc: fix plist.h comments

Make kernel-doc comments match macro names.
Correct parameter names in a few places.
Remove '#' from beginning of kernel-doc comment macro names.
Remove extra (erroneous) blank lines in kernel-doc.

Warning(plist.h:100): Cannot understand * #PLIST_HEAD_INIT - static struct plist_head initializer on line 100 - I thought it was a doc line
Warning(plist.h:112): Cannot understand * #PLIST_NODE_INIT - static struct plist_node initializer on line 112 - I thought it was a doc line
Warning(plist.h:103): No description found for parameter '_lock'
Warning(plist.h:129): No description found for parameter 'lock'
Warning(plist.h:158): No description found for parameter 'pos'
Warning(plist.h:169): No description found for parameter 'pos'
Warning(plist.h:169): No description found for parameter 'n'
Warning(plist.h:179): No description found for parameter 'mem'

This still leaves one warning & one error that need attention:
Error(plist.h:219): cannot understand prototype: '('
Warning(plist.h): no structured comments found

Acked-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Cc: Daniel Walker <dwalker@mvista.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Oleg Nesterov <oleg@tv-sign.ru>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

Randy Dunlap and committed by
Linus Torvalds
11265420 c4bbafda

+23 -31
+23 -31
include/linux/plist.h
··· 97 97 #endif 98 98 99 99 /** 100 - * #PLIST_HEAD_INIT - static struct plist_head initializer 101 - * 100 + * PLIST_HEAD_INIT - static struct plist_head initializer 102 101 * @head: struct plist_head variable name 102 + * @_lock: lock to initialize for this list 103 103 */ 104 104 #define PLIST_HEAD_INIT(head, _lock) \ 105 105 { \ ··· 109 109 } 110 110 111 111 /** 112 - * #PLIST_NODE_INIT - static struct plist_node initializer 113 - * 112 + * PLIST_NODE_INIT - static struct plist_node initializer 114 113 * @node: struct plist_node variable name 115 114 * @__prio: initial node priority 116 115 */ ··· 121 122 122 123 /** 123 124 * plist_head_init - dynamic struct plist_head initializer 124 - * 125 125 * @head: &struct plist_head pointer 126 + * @lock: list spinlock, remembered for debugging 126 127 */ 127 128 static inline void 128 129 plist_head_init(struct plist_head *head, spinlock_t *lock) ··· 136 137 137 138 /** 138 139 * plist_node_init - Dynamic struct plist_node initializer 139 - * 140 140 * @node: &struct plist_node pointer 141 141 * @prio: initial node priority 142 142 */ ··· 150 152 151 153 /** 152 154 * plist_for_each - iterate over the plist 153 - * 154 - * @pos1: the type * to use as a loop counter. 155 - * @head: the head for your list. 155 + * @pos: the type * to use as a loop counter 156 + * @head: the head for your list 156 157 */ 157 158 #define plist_for_each(pos, head) \ 158 159 list_for_each_entry(pos, &(head)->node_list, plist.node_list) 159 160 160 161 /** 161 - * plist_for_each_entry_safe - iterate over a plist of given type safe 162 - * against removal of list entry 162 + * plist_for_each_safe - iterate safely over a plist of given type 163 + * @pos: the type * to use as a loop counter 164 + * @n: another type * to use as temporary storage 165 + * @head: the head for your list 163 166 * 164 - * @pos1: the type * to use as a loop counter. 165 - * @n1: another type * to use as temporary storage 166 - * @head: the head for your list. 167 + * Iterate over a plist of given type, safe against removal of list entry. 167 168 */ 168 169 #define plist_for_each_safe(pos, n, head) \ 169 170 list_for_each_entry_safe(pos, n, &(head)->node_list, plist.node_list) 170 171 171 172 /** 172 173 * plist_for_each_entry - iterate over list of given type 173 - * 174 - * @pos: the type * to use as a loop counter. 175 - * @head: the head for your list. 176 - * @member: the name of the list_struct within the struct. 174 + * @pos: the type * to use as a loop counter 175 + * @head: the head for your list 176 + * @mem: the name of the list_struct within the struct 177 177 */ 178 178 #define plist_for_each_entry(pos, head, mem) \ 179 179 list_for_each_entry(pos, &(head)->node_list, mem.plist.node_list) 180 180 181 181 /** 182 - * plist_for_each_entry_safe - iterate over list of given type safe against 183 - * removal of list entry 184 - * 185 - * @pos: the type * to use as a loop counter. 182 + * plist_for_each_entry_safe - iterate safely over list of given type 183 + * @pos: the type * to use as a loop counter 186 184 * @n: another type * to use as temporary storage 187 - * @head: the head for your list. 188 - * @m: the name of the list_struct within the struct. 185 + * @head: the head for your list 186 + * @m: the name of the list_struct within the struct 187 + * 188 + * Iterate over list of given type, safe against removal of list entry. 189 189 */ 190 190 #define plist_for_each_entry_safe(pos, n, head, m) \ 191 191 list_for_each_entry_safe(pos, n, &(head)->node_list, m.plist.node_list) 192 192 193 193 /** 194 194 * plist_head_empty - return !0 if a plist_head is empty 195 - * 196 195 * @head: &struct plist_head pointer 197 196 */ 198 197 static inline int plist_head_empty(const struct plist_head *head) ··· 199 204 200 205 /** 201 206 * plist_node_empty - return !0 if plist_node is not on a list 202 - * 203 207 * @node: &struct plist_node pointer 204 208 */ 205 209 static inline int plist_node_empty(const struct plist_node *node) ··· 210 216 211 217 /** 212 218 * plist_first_entry - get the struct for the first entry 213 - * 214 - * @ptr: the &struct plist_head pointer. 215 - * @type: the type of the struct this is embedded in. 216 - * @member: the name of the list_struct within the struct. 219 + * @head: the &struct plist_head pointer 220 + * @type: the type of the struct this is embedded in 221 + * @member: the name of the list_struct within the struct 217 222 */ 218 223 #ifdef CONFIG_DEBUG_PI_LIST 219 224 # define plist_first_entry(head, type, member) \ ··· 227 234 228 235 /** 229 236 * plist_first - return the first node (and thus, highest priority) 230 - * 231 237 * @head: the &struct plist_head pointer 232 238 * 233 239 * Assumes the plist is _not_ empty.