Commit 201a0883 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jakub Kicinski
Browse files

net: llc: fix kernel-doc notation warnings 



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: 1da177e4 ("Linux-2.6.12-rc2")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20230714045127.18752-7-rdunlap@infradead.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent d20909a0

include/net/llc_pdu.h

+4 −2
Original line number Diff line number Diff line
@@ -269,7 +269,7 @@ static inline void llc_pdu_decode_sa(struct sk_buff *skb, u8 *sa) 
/**

 *	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_cmd(struct sk_buff *skb) 


/**

 *	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.