netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: netdev@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	Yi Yang <yi.y.yang@intel.com>, Jiri Benc <jbenc@redhat.com>
Subject: [PATCH net 10/12] net: NSH: fix kernel-doc notation warning
Date: Mon, 10 Jul 2023 16:03:10 -0700	[thread overview]
Message-ID: <20230710230312.31197-11-rdunlap@infradead.org> (raw)
In-Reply-To: <20230710230312.31197-1-rdunlap@infradead.org>

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: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: Yi Yang <yi.y.yang@intel.com>
Cc: Jiri Benc <jbenc@redhat.com>
---
 include/net/nsh.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/include/net/nsh.h b/include/net/nsh.h
--- 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];

  parent reply	other threads:[~2023-07-10 23:03 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-10 23:03 [PATCH net 00/12] net: fix kernel-doc problems in include/net/ Randy Dunlap
2023-07-10 23:03 ` [PATCH net 01/12] net: bonding: remove kernel-doc comment marker Randy Dunlap
2023-07-10 23:03 ` [PATCH net 02/12] wifi: cfg80211: remove dead/unused enum value Randy Dunlap
2023-07-10 23:03 ` [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings Randy Dunlap
2023-07-11  8:36   ` Miquel Raynal
2023-07-10 23:03 ` [PATCH net 04/12] codel: " Randy Dunlap
2023-07-10 23:03 ` [PATCH net 05/12] devlink: " Randy Dunlap
2023-07-10 23:03 ` [PATCH net 06/12] wifi: radiotap: " Randy Dunlap
2023-07-10 23:03 ` [PATCH net 07/12] inet: frags: remove kernel-doc comment marker Randy Dunlap
2023-07-12  3:34   ` Jakub Kicinski
2023-07-12  3:48     ` Randy Dunlap
2023-07-10 23:03 ` [PATCH net 08/12] net: llc: fix kernel-doc notation warnings Randy Dunlap
2023-07-10 23:03 ` [PATCH net 09/12] wifi: mac80211: fix kernel-doc notation warning Randy Dunlap
2023-07-12  3:37   ` Jakub Kicinski
2023-07-12  3:46     ` Randy Dunlap
2023-07-10 23:03 ` Randy Dunlap [this message]
2023-07-10 23:03 ` [PATCH net 11/12] pie: " Randy Dunlap
2023-07-10 23:03 ` [PATCH net 12/12] rsi: remove kernel-doc comment marker Randy Dunlap
2023-07-11  8:58   ` Kalle Valo
2023-07-12  3:37   ` Jakub Kicinski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230710230312.31197-11-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=jbenc@redhat.com \
    --cc=kuba@kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=yi.y.yang@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).