kfifo: fix Error/broken kernel-doc notation

Fix kernel-doc errors and warnings in new header file kfifo.h.
Don't use kernel-doc "/**" for internal functions whose comments
are not in kernel-doc format.

kernel-doc section header names (like "Note:") must be unique
per function. Looks like I need to document that.

Error(include/linux/kfifo.h:76): duplicate section name 'Note'
Warning(include/linux/kfifo.h:88): Excess function parameter 'size' description in 'INIT_KFIFO'
Error(include/linux/kfifo.h:101): duplicate section name 'Note'
Warning(include/linux/kfifo.h:257): No description found for parameter 'fifo'
(many of this last type, from internal functions)

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Stefani Seibold <stefani@seibold.net>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

authored by

Randy Dunlap and committed by

Linus Torvalds 16 years ago 9c717de9 6432ed64

+15 -16

1 changed file

expand all

include

linux

kfifo.h

+15 -16

include/linux/kfifo.h

··· 69 69 * @name: name of the declared kfifo datatype 70 70 * @size: size of the fifo buffer 71 71 * 72 - * Note: the macro can be used inside struct or union declaration 73 - * Note: the macro creates two objects: 72 + * Note1: the macro can be used inside struct or union declaration 73 + * Note2: the macro creates two objects: 74 74 * A kfifo object with the given name and a buffer for the kfifo 75 75 * object named name##kfifo_buffer 76 76 */ ··· 83 83 /** 84 84 * INIT_KFIFO - Initialize a kfifo declared by DECLARED_KFIFO 85 85 * @name: name of the declared kfifo datatype 86 - * @size: size of the fifo buffer 87 86 */ 88 87 #define INIT_KFIFO(name) \ 89 88 name = __kfifo_initializer(sizeof(name##kfifo_buffer) - \ ··· 93 94 * @name: name of the declared kfifo datatype 94 95 * @size: size of the fifo buffer 95 96 * 96 - * Note: the macro can be used for global and local kfifo data type variables 97 - * Note: the macro creates two objects: 97 + * Note1: the macro can be used for global and local kfifo data type variables 98 + * Note2: the macro creates two objects: 98 99 * A kfifo object with the given name and a buffer for the kfifo 99 100 * object named name##kfifo_buffer 100 101 */ ··· 248 249 extern __must_check unsigned int kfifo_to_user(struct kfifo *fifo, 249 250 void __user *to, unsigned int n); 250 251 251 - /** 252 + /* 252 253 * __kfifo_add_out internal helper function for updating the out offset 253 254 */ 254 255 static inline void __kfifo_add_out(struct kfifo *fifo, ··· 258 259 fifo->out += off; 259 260 } 260 261 261 - /** 262 + /* 262 263 * __kfifo_add_in internal helper function for updating the in offset 263 264 */ 264 265 static inline void __kfifo_add_in(struct kfifo *fifo, ··· 268 269 fifo->in += off; 269 270 } 270 271 271 - /** 272 + /* 272 273 * __kfifo_off internal helper function for calculating the index of a 273 274 * given offeset 274 275 */ ··· 277 278 return off & (fifo->size - 1); 278 279 } 279 280 280 - /** 281 + /* 281 282 * __kfifo_peek_n internal helper function for determinate the length of 282 283 * the next record in the fifo 283 284 */ ··· 298 299 #undef __KFIFO_GET 299 300 } 300 301 301 - /** 302 + /* 302 303 * __kfifo_poke_n internal helper function for storing the length of 303 304 * the next record into the fifo 304 305 */ ··· 318 319 #undef __KFIFO_PUT 319 320 } 320 321 321 - /** 322 + /* 322 323 * __kfifo_in_... internal functions for put date into the fifo 323 324 * do not call it directly, use kfifo_in_rec() instead 324 325 */ ··· 366 367 return __kfifo_in_rec(fifo, from, n, recsize); 367 368 } 368 369 369 - /** 370 + /* 370 371 * __kfifo_out_... internal functions for get date from the fifo 371 372 * do not call it directly, use kfifo_out_rec() instead 372 373 */ ··· 424 425 return __kfifo_out_rec(fifo, to, n, recsize, total); 425 426 } 426 427 427 - /** 428 + /* 428 429 * __kfifo_from_user_... internal functions for transfer from user space into 429 430 * the fifo. do not call it directly, use kfifo_from_user_rec() instead 430 431 */ ··· 473 474 return __kfifo_from_user_rec(fifo, from, n, recsize); 474 475 } 475 476 476 - /** 477 + /* 477 478 * __kfifo_to_user_... internal functions for transfer fifo data into user space 478 479 * do not call it directly, use kfifo_to_user_rec() instead 479 480 */ ··· 532 533 return __kfifo_to_user_rec(fifo, to, n, recsize, total); 533 534 } 534 535 535 - /** 536 + /* 536 537 * __kfifo_peek_... internal functions for peek into the next fifo record 537 538 * do not call it directly, use kfifo_peek_rec() instead 538 539 */ ··· 556 557 return __kfifo_peek_n(fifo, recsize); 557 558 } 558 559 559 - /** 560 + /* 560 561 * __kfifo_skip_... internal functions for skip the next fifo record 561 562 * do not call it directly, use kfifo_skip_rec() instead 562 563 */

Configure Feed

Configure Feed