Commit 8c966a10 authored by Simon Horman's avatar Simon Horman Committed by Jakub Kicinski
Browse files

flow_dissector: Address kdoc warnings 



Address a number of warnings flagged by
./scripts/kernel-doc -none include/net/flow_dissector.h

 include/net/flow_dissector.h:23: warning: Function parameter or member 'addr_type' not described in 'flow_dissector_key_control'
 include/net/flow_dissector.h:23: warning: Function parameter or member 'flags' not described in 'flow_dissector_key_control'
 include/net/flow_dissector.h:46: warning: Function parameter or member 'padding' not described in 'flow_dissector_key_basic'
 include/net/flow_dissector.h:145: warning: Function parameter or member 'tipckey' not described in 'flow_dissector_key_addrs'
 include/net/flow_dissector.h:157: warning: cannot understand function prototype: 'struct flow_dissector_key_arp '
 include/net/flow_dissector.h:171: warning: cannot understand function prototype: 'struct flow_dissector_key_ports '
 include/net/flow_dissector.h:203: warning: cannot understand function prototype: 'struct flow_dissector_key_icmp '

Also improve indentation on adjacent lines to those changed
to address the above.

No functional changes intended.

Signed-off-by: default avatarSimon Horman <horms@kernel.org>
Link: https://lore.kernel.org/r/20230419-flow-dissector-kdoc-v1-1-1aa0cca1118b@kernel.org


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

include/net/flow_dissector.h

+20 −18
Original line number Diff line number Diff line
@@ -15,6 +15,8 @@ struct sk_buff; 
/**

 * struct flow_dissector_key_control:

 * @thoff:     Transport header offset

 * @addr_type: Type of key. One of FLOW_DISSECTOR_KEY_*

 * @flags:     Key flags. Any of FLOW_DIS_(IS_FRAGMENT|FIRST_FRAGENCAPSULATION)

 */

struct flow_dissector_key_control {

	u16	thoff;
@@ -38,6 +40,7 @@ enum flow_dissect_ret { 
 * struct flow_dissector_key_basic:

 * @n_proto:  Network header protocol (eg. IPv4/IPv6)

 * @ip_proto: Transport header protocol (eg. TCP/UDP)

 * @padding:  Unused

 */

struct flow_dissector_key_basic {

	__be16	n_proto;
@@ -135,6 +138,7 @@ struct flow_dissector_key_tipc { 
 * struct flow_dissector_key_addrs:

 * @v4addrs: IPv4 addresses

 * @v6addrs: IPv6 addresses

 * @tipckey: TIPC key

 */

struct flow_dissector_key_addrs {

	union {
@@ -145,14 +149,12 @@ struct flow_dissector_key_addrs { 
};



/**

 * flow_dissector_key_arp:

 *	@ports: Operation, source and target addresses for an ARP header

 *              for Ethernet hardware addresses and IPv4 protocol addresses

 *		sip: Sender IP address

 *		tip: Target IP address

 *		op:  Operation

 *		sha: Sender hardware address

 *		tpa: Target hardware address

 * struct flow_dissector_key_arp:

 * @sip: Sender IP address

 * @tip: Target IP address

 * @op:  Operation

 * @sha: Sender hardware address

 * @tha: Target hardware address

 */

struct flow_dissector_key_arp {

	__u32 sip;
@@ -163,10 +165,10 @@ struct flow_dissector_key_arp { 
};



/**

 * flow_dissector_key_tp_ports:

 * struct flow_dissector_key_ports:

 * @ports: port numbers of Transport header

 *		src: source port number

 *		dst: destination port number

 * @src: source port number

 * @dst: destination port number

 */

struct flow_dissector_key_ports {

	union {
@@ -195,10 +197,10 @@ struct flow_dissector_key_ports_range { 
};



/**

 * flow_dissector_key_icmp:

 *		type: ICMP type

 *		code: ICMP code

 *		id:   session identifier

 * struct flow_dissector_key_icmp:

 * @type: ICMP type

 * @code: ICMP code

 * @id:   Session identifier

 */

struct flow_dissector_key_icmp {

	struct {