diff options
| author |   Jesse Brandeburg <jesse.brandeburg@intel.com> | 2020-09-25 15:24:37 -0700 |
|---|---|---|
| committer |   David S. Miller <davem@davemloft.net> | 2020-09-25 16:28:59 -0700 |
| commit | b50f7bca5e83d9e8306ceb2a8b0ef0ed2416f133 (patch) | |
| tree | 5453c8f802bf77007701d674ea742693e8f038ee /drivers/net/ethernet/intel/i40e/i40e_txrx_common.h | |
| parent | net: vlan: Avoid using BUG() in vlan_proto_idx() (diff) | |
| download | wireguard-linux-b50f7bca5e83d9e8306ceb2a8b0ef0ed2416f133.tar.xz wireguard-linux-b50f7bca5e83d9e8306ceb2a8b0ef0ed2416f133.zip | |
intel-ethernet: clean up W=1 warnings in kdoc
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>
Diffstat (limited to 'drivers/net/ethernet/intel/i40e/i40e_txrx_common.h')
| -rw-r--r-- | drivers/net/ethernet/intel/i40e/i40e_txrx_common.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/drivers/net/ethernet/intel/i40e/i40e_txrx_common.h b/drivers/net/ethernet/intel/i40e/i40e_txrx_common.h index 1397dd3c1c57..19da3b22160f 100644 --- a/drivers/net/ethernet/intel/i40e/i40e_txrx_common.h +++ b/drivers/net/ethernet/intel/i40e/i40e_txrx_common.h @@ -21,9 +21,9 @@ void i40e_release_rx_desc(struct i40e_ring *rx_ring, u32 val); #define I40E_XDP_TX BIT(1) #define I40E_XDP_REDIR BIT(2) -/** +/* * build_ctob - Builds the Tx descriptor (cmd, offset and type) qword - **/ + */ static inline __le64 build_ctob(u32 td_cmd, u32 td_offset, unsigned int size, u32 td_tag) { @@ -37,7 +37,7 @@ static inline __le64 build_ctob(u32 td_cmd, u32 td_offset, unsigned int size, /** * i40e_update_tx_stats - Update the egress statistics for the Tx ring * @tx_ring: Tx ring to update - * @total_packet: total packets sent + * @total_packets: total packets sent * @total_bytes: total bytes sent **/ static inline void i40e_update_tx_stats(struct i40e_ring *tx_ring, |