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

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.orgSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent dd64b232
...@@ -14,7 +14,9 @@ struct sk_buff; ...@@ -14,7 +14,9 @@ struct sk_buff;
/** /**
* struct flow_dissector_key_control: * struct flow_dissector_key_control:
* @thoff: Transport header offset * @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 { struct flow_dissector_key_control {
u16 thoff; u16 thoff;
...@@ -36,8 +38,9 @@ enum flow_dissect_ret { ...@@ -36,8 +38,9 @@ enum flow_dissect_ret {
/** /**
* struct flow_dissector_key_basic: * struct flow_dissector_key_basic:
* @n_proto: Network header protocol (eg. IPv4/IPv6) * @n_proto: Network header protocol (eg. IPv4/IPv6)
* @ip_proto: Transport header protocol (eg. TCP/UDP) * @ip_proto: Transport header protocol (eg. TCP/UDP)
* @padding: Unused
*/ */
struct flow_dissector_key_basic { struct flow_dissector_key_basic {
__be16 n_proto; __be16 n_proto;
...@@ -135,6 +138,7 @@ struct flow_dissector_key_tipc { ...@@ -135,6 +138,7 @@ struct flow_dissector_key_tipc {
* struct flow_dissector_key_addrs: * struct flow_dissector_key_addrs:
* @v4addrs: IPv4 addresses * @v4addrs: IPv4 addresses
* @v6addrs: IPv6 addresses * @v6addrs: IPv6 addresses
* @tipckey: TIPC key
*/ */
struct flow_dissector_key_addrs { struct flow_dissector_key_addrs {
union { union {
...@@ -145,14 +149,12 @@ struct flow_dissector_key_addrs { ...@@ -145,14 +149,12 @@ struct flow_dissector_key_addrs {
}; };
/** /**
* flow_dissector_key_arp: * struct flow_dissector_key_arp:
* @ports: Operation, source and target addresses for an ARP header * @sip: Sender IP address
* for Ethernet hardware addresses and IPv4 protocol addresses * @tip: Target IP address
* sip: Sender IP address * @op: Operation
* tip: Target IP address * @sha: Sender hardware address
* op: Operation * @tha: Target hardware address
* sha: Sender hardware address
* tpa: Target hardware address
*/ */
struct flow_dissector_key_arp { struct flow_dissector_key_arp {
__u32 sip; __u32 sip;
...@@ -163,10 +165,10 @@ struct flow_dissector_key_arp { ...@@ -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 * @ports: port numbers of Transport header
* src: source port number * @src: source port number
* dst: destination port number * @dst: destination port number
*/ */
struct flow_dissector_key_ports { struct flow_dissector_key_ports {
union { union {
...@@ -195,10 +197,10 @@ struct flow_dissector_key_ports_range { ...@@ -195,10 +197,10 @@ struct flow_dissector_key_ports_range {
}; };
/** /**
* flow_dissector_key_icmp: * struct flow_dissector_key_icmp:
* type: ICMP type * @type: ICMP type
* code: ICMP code * @code: ICMP code
* id: session identifier * @id: Session identifier
*/ */
struct flow_dissector_key_icmp { struct flow_dissector_key_icmp {
struct { struct {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment