intel-ethernet: clean up W=1 warnings in kdoc

Browse source

This takes care of all of the trivial W=1 fixes in the Intel
Ethernet drivers, which allows developers and maintainers to
build more of the networking tree with more complete warning
checks.

There are three classes of kdoc warnings fixed:
 - cannot understand function prototype: 'x'
 - Excess function parameter 'x' description in 'y'
 - Function parameter or member 'x' not described in 'y'

All of the changes were trivial comment updates on
function headers.

Inspired by Lee Jones' series of wireless work to do the same.
Compile tested only, and passes simple test of
$ git ls-files *.[ch] | egrep drivers/net/ethernet/intel | \
  xargs scripts/kernel-doc -none

Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
Tested-by: Aaron Brown <aaron.f.brown@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

...

This commit is contained in:

Jesse Brandeburg 2020-09-25 15:24:37 -07:00 • committed by David S. Miller

parent d0186842ec

commit b50f7bca5e

38 changed files with 185 additions and 129 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

2

drivers/net/ethernet/intel/e100.c

View file

7

drivers/net/ethernet/intel/e1000/e1000_hw.c

View file

39

drivers/net/ethernet/intel/e1000/e1000_main.c

View file

1

drivers/net/ethernet/intel/e1000e/80003es2lan.c

View file

16

drivers/net/ethernet/intel/e1000e/ich8lan.c

View file

50

drivers/net/ethernet/intel/e1000e/netdev.c

View file

3

drivers/net/ethernet/intel/e1000e/phy.c

View file

2

drivers/net/ethernet/intel/e1000e/ptp.c

View file

4

drivers/net/ethernet/intel/i40e/i40e_adminq.h

View file

2

drivers/net/ethernet/intel/i40e/i40e_client.c

View file

4

drivers/net/ethernet/intel/i40e/i40e_common.c

View file

17

drivers/net/ethernet/intel/i40e/i40e_main.c

View file

1

drivers/net/ethernet/intel/i40e/i40e_ptp.c

View file

2

drivers/net/ethernet/intel/i40e/i40e_trace.h

View file

7

drivers/net/ethernet/intel/i40e/i40e_txrx.c

View file

1

drivers/net/ethernet/intel/i40e/i40e_txrx.h

View file

6

drivers/net/ethernet/intel/i40e/i40e_txrx_common.h

View file

9

drivers/net/ethernet/intel/i40e/i40e_virtchnl_pf.c

View file

4

drivers/net/ethernet/intel/iavf/iavf_adminq.h

View file

20

drivers/net/ethernet/intel/iavf/iavf_main.c

View file

2

drivers/net/ethernet/intel/iavf/iavf_trace.h

View file

2

drivers/net/ethernet/intel/iavf/iavf_txrx.h

View file

2

drivers/net/ethernet/intel/ice/ice.h

View file

6

drivers/net/ethernet/intel/ice/ice_adminq_cmd.h

View file

2

drivers/net/ethernet/intel/ice/ice_txrx.h

View file

6

drivers/net/ethernet/intel/igb/e1000_82575.c

View file

5

drivers/net/ethernet/intel/igb/e1000_i210.c

View file

1

drivers/net/ethernet/intel/igb/e1000_mac.c

View file

1

drivers/net/ethernet/intel/igb/e1000_mbx.c

View file

28

drivers/net/ethernet/intel/igb/igb_main.c

View file

8

drivers/net/ethernet/intel/igb/igb_ptp.c

View file

17

drivers/net/ethernet/intel/igbvf/netdev.c

View file

2

drivers/net/ethernet/intel/igc/igc_main.c

View file

4

drivers/net/ethernet/intel/igc/igc_ptp.c

View file

17

drivers/net/ethernet/intel/ixgb/ixgb_main.c

View file

3

drivers/net/ethernet/intel/ixgbe/ixgbe_main.c

View file

8

drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c

View file

3

drivers/net/ethernet/intel/ixgbevf/ixgbevf_main.c

View file