2022-11-09 04:23:18

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] lib: objpool: Fix some kernel-doc comments

Make the description of @oh to @head in objpool_pop()
to clear the below warnings:

lib/objpool.c:425: warning: Excess function parameter 'oh' description in 'objpool_pop'
lib/objpool.c:425: warning: Function parameter or member 'head' not described in 'objpool_pop'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2821
Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
lib/objpool.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/objpool.c b/lib/objpool.c
index ecffa0795f3d..96cd43eb53e1 100644
--- a/lib/objpool.c
+++ b/lib/objpool.c
@@ -414,7 +414,7 @@ static inline void *__objpool_try_get_slot(struct objpool_slot *os)
* objpool_pop: allocate an object from objects pool
*
* args:
- * @oh: object pool
+ * @head: object pool used to allocate an object
*
* return:
* object: NULL if failed (object pool is empty)
--
2.20.1.7.g153144c