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>
Subject: [PATCH net 08/12] net: llc: fix kernel-doc notation warnings
Date: Mon, 10 Jul 2023 16:03:08 -0700 [thread overview]
Message-ID: <20230710230312.31197-9-rdunlap@infradead.org> (raw)
In-Reply-To: <20230710230312.31197-1-rdunlap@infradead.org>
Use the corrent function parameter name or format to prevent
kernel-doc warnings.
Add 2 function parameter descriptions to prevent kernel-doc warnings.
llc_pdu.h:278: warning: Function parameter or member 'da' not described in 'llc_pdu_decode_da'
llc_pdu.h:278: warning: Excess function parameter 'sa' description in 'llc_pdu_decode_da'
llc_pdu.h:330: warning: Function parameter or member 'skb' not described in 'llc_pdu_init_as_test_cmd'
llc_pdu.h:379: warning: Function parameter or member 'svcs_supported' not described in 'llc_pdu_init_as_xid_cmd'
llc_pdu.h:379: warning: Function parameter or member 'rx_window' not described in 'llc_pdu_init_as_xid_cmd'
Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
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>
---
include/net/llc_pdu.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff -- a/include/net/llc_pdu.h b/include/net/llc_pdu.h
--- a/include/net/llc_pdu.h
+++ b/include/net/llc_pdu.h
@@ -269,7 +269,7 @@ static inline void llc_pdu_decode_sa(str
/**
* llc_pdu_decode_da - extracts dest address of input frame
* @skb: input skb that destination address must be extracted from it
- * @sa: pointer to destination address (6 byte array).
+ * @da: pointer to destination address (6 byte array).
*
* This function extracts destination address(MAC) of input frame.
*/
@@ -321,7 +321,7 @@ static inline void llc_pdu_init_as_ui_cm
/**
* llc_pdu_init_as_test_cmd - sets PDU as TEST
- * @skb - Address of the skb to build
+ * @skb: Address of the skb to build
*
* Sets a PDU as TEST
*/
@@ -369,6 +369,8 @@ struct llc_xid_info {
/**
* llc_pdu_init_as_xid_cmd - sets bytes 3, 4 & 5 of LLC header as XID
* @skb: input skb that header must be set into it.
+ * @svcs_supported: The class of the LLC (I or II)
+ * @rx_window: The size of the receive window of the LLC
*
* This function sets third,fourth,fifth and sixth bytes of LLC header as
* a XID PDU.
next prev 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 ` Randy Dunlap [this message]
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 ` [PATCH net 10/12] net: NSH: " Randy Dunlap
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-9-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=kuba@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.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).