From: Randy Dunlap <rdunlap@infradead.org>
Date: Fri, 14 Jul 2023 04:51:25 +0000 (-0700)
Subject: net: NSH: fix kernel-doc notation warning
X-Git-Tag: v6.6.17~4350^2~29^2~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d1533d726aa1efca3a7ae8f40c94ccb149d22e6a;p=platform%2Fkernel%2Flinux-rpi.git

net: NSH: fix kernel-doc notation warning

Use the struct member's name and the correct format to prevent a
kernel-doc warning.

nsh.h:200: warning: Function parameter or member 'context' not described in 'nsh_md1_ctx'

Fixes: 1f0b7744c505 ("net: add NSH header structures and helpers")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jiri Benc <jbenc@redhat.com>
Link: https://lore.kernel.org/r/20230714045127.18752-8-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---

diff --git a/include/net/nsh.h b/include/net/nsh.h
index 350b1ad..16a7510 100644
--- a/include/net/nsh.h
+++ b/include/net/nsh.h
@@ -192,7 +192,7 @@
 
 /**
  * struct nsh_md1_ctx - Keeps track of NSH context data
- * @nshc<1-4>: NSH Contexts.
+ * @context: NSH Contexts.
  */
 struct nsh_md1_ctx {
 	__be32 context[4];