[v1] lib: Fix some kernel-doc comments

[PATCH -next] lib: Fix some kernel-doc comments

Posted by Yang Li 3 years, 5 months ago

Make the description of @policy to @p in nla_policy_len()
to clear the below warnings:

lib/nlattr.c:660: warning: Function parameter or member 'p' not described in 'nla_policy_len'
lib/nlattr.c:660: warning: Excess function parameter 'policy' description in 'nla_policy_len'

Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2736
Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 lib/nlattr.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/nlattr.c b/lib/nlattr.c
index b67a53e29b8f..9055e8b4d144 100644
--- a/lib/nlattr.c
+++ b/lib/nlattr.c
@@ -646,7 +646,7 @@ EXPORT_SYMBOL(__nla_validate);
 
 /**
  * nla_policy_len - Determine the max. length of a policy
- * @policy: policy to use
+ * @p: policy to use
  * @n: number of policies
  *
  * Determines the max. length of the policy.  It is currently used
-- 
2.20.1.7.g153144c

Re: [PATCH -next] lib: Fix some kernel-doc comments

Posted by Jakub Kicinski 3 years, 5 months ago

On Fri,  4 Nov 2022 14:31:19 +0800 Yang Li wrote:
> Make the description of @policy to @p in nla_policy_len()
> to clear the below warnings:
> 
> lib/nlattr.c:660: warning: Function parameter or member 'p' not described in 'nla_policy_len'
> lib/nlattr.c:660: warning: Excess function parameter 'policy' description in 'nla_policy_len'
> 
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=2736
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Repost it and cc netdev@ please