History

netdevice.h: fix all kernel-doc and Sphinx warnings

Eliminate all kernel-doc and Sphinx warnings in <linux/netdevice.h>. Fixes these warnings: ../include/linux/netdevice.h:2100: warning: Function parameter or member 'gso_partial_features' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'l3mdev_ops' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'xfrmdev_ops' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'tlsdev_ops' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'name_assign_type' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'ieee802154_ptr' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'mpls_ptr' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'xdp_prog' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'gro_flush_timeout' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'xdp_bulkq' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'xps_cpus_map' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'xps_rxqs_map' not described in 'net_device' ../include/linux/netdevice.h:2100: warning: Function parameter or member 'qdisc_hash' not described in 'net_device' ../include/linux/netdevice.h:3552: WARNING: Inline emphasis start-string without end-string. ../include/linux/netdevice.h:3552: WARNING: Inline emphasis start-string without end-string.

Randy Dunlap committed 6 years ago

Commit a1fa83b1 parent 3ea89fa1 file · +15 −1Browse files

Showing the changes to include/linux (1 of 1 file). Show all

Unified · Split

include/linux/netdevice.h+15−1
@@ -1616,6 +1616,7 @@ enum netdev_priv_flags { · 1615 unmodified lines
16161616 * and drivers will need to set them appropriately.
16171617 *
16181618 * @mpls_features: Mask of features inheritable by MPLS
1619+ * @gso_partial_features: value(s) from NETIF_F_GSO\*
16191620 *
16201621 * @ifindex: interface index
16211622 * @group: The group the device belongs to
@@ -1640,8 +1641,11 @@ enum netdev_priv_flags { · 18 unmodified lines
16401641 * @netdev_ops: Includes several pointers to callbacks,
16411642 * if one wants to override the ndo_*() functions
16421643 * @ethtool_ops: Management operations
1644+ * @l3mdev_ops: Layer 3 master device operations
16431645 * @ndisc_ops: Includes callbacks for different IPv6 neighbour
16441646 * discovery handling. Necessary for e.g. 6LoWPAN.
1647+ * @xfrmdev_ops: Transformation offload operations
1648+ * @tlsdev_ops: Transport Layer Security offload operations
16451649 * @header_ops: Includes callbacks for creating,parsing,caching,etc
16461650 * of Layer 2 headers.
16471651 *
@@ -1680,6 +1684,7 @@ enum netdev_priv_flags { · 32 unmodified lines
16801684 * @dev_port: Used to differentiate devices that share
16811685 * the same function
16821686 * @addr_list_lock: XXX: need comments on this one
1687+ * @name_assign_type: network interface name assignment type
16831688 * @uc_promisc: Counter that indicates promiscuous mode
16841689 * has been enabled due to the need to listen to
16851690 * additional unicast addresses in a device that
@@ -1702,6 +1707,9 @@ enum netdev_priv_flags { · 16 unmodified lines
17021707 * @ip6_ptr: IPv6 specific data
17031708 * @ax25_ptr: AX.25 specific data
17041709 * @ieee80211_ptr: IEEE 802.11 specific data, assign before registering
1710+ * @ieee802154_ptr: IEEE 802.15.4 low-rate Wireless Personal Area Network
1711+ * device struct
1712+ * @mpls_ptr: mpls_dev struct pointer
17051713 *
17061714 * @dev_addr: Hw address (before bcast,
17071715 * because most packets are unicast)
@@ -1710,6 +1718,8 @@ enum netdev_priv_flags { · 2 unmodified lines
17101718 * @num_rx_queues: Number of RX queues
17111719 * allocated at register_netdev() time
17121720 * @real_num_rx_queues: Number of RX queues currently active in device
1721+ * @xdp_prog: XDP sockets filter program pointer
1722+ * @gro_flush_timeout: timeout for GRO layer in NAPI
17131723 *
17141724 * @rx_handler: handler for received packets
17151725 * @rx_handler_data: XXX: need comments on this one
@@ -1731,10 +1741,14 @@ enum netdev_priv_flags { · 15 unmodified lines
17311741 * @qdisc: Root qdisc from userspace point of view
17321742 * @tx_queue_len: Max frames per queue allowed
17331743 * @tx_global_lock: XXX: need comments on this one
1744+ * @xdp_bulkq: XDP device bulk queue
1745+ * @xps_cpus_map: all CPUs map for XPS device
1746+ * @xps_rxqs_map: all RXQs map for XPS device
17341747 *
17351748 * @xps_maps: XXX: need comments on this one
17361749 * @miniq_egress: clsact qdisc specific data for
17371750 * egress processing
1751+ * @qdisc_hash: qdisc hash table
17381752 * @watchdog_timeo: Represents the timeout that is used by
17391753 * the watchdog (see dev_watchdog())
17401754 * @watchdog_timer: List of timers
@@ -3548,7 +3562,7 @@ static inline unsigned int netif_attrmask_next(int n, const unsigned long *srcp, · 1807 unmodified lines
35483562 }
35493563
35503564 /**
3551− * netif_attrmask_next_and - get the next CPU/Rx queue in *src1p & *src2p
3565+ * netif_attrmask_next_and - get the next CPU/Rx queue in \*src1p & \*src2p
35523566 * @n: CPU/Rx queue index
35533567 * @src1p: the first CPUs/Rx queues mask pointer
35543568 * @src2p: the second CPUs/Rx queues mask pointer