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/iavf/iavf_adminq.h | |
| parent | d0186842ec5f456af531c66ee1ca64a8682695e6 (diff) | |
| download | linux-stable-b50f7bca5e83d9e8306ceb2a8b0ef0ed2416f133.tar.gz linux-stable-b50f7bca5e83d9e8306ceb2a8b0ef0ed2416f133.tar.bz2 linux-stable-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/iavf/iavf_adminq.h')
| -rw-r--r-- | drivers/net/ethernet/intel/iavf/iavf_adminq.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/drivers/net/ethernet/intel/iavf/iavf_adminq.h b/drivers/net/ethernet/intel/iavf/iavf_adminq.h index baf2fe26f302..1f60518eb0e5 100644 --- a/drivers/net/ethernet/intel/iavf/iavf_adminq.h +++ b/drivers/net/ethernet/intel/iavf/iavf_adminq.h @@ -85,8 +85,8 @@ struct iavf_adminq_info { /** * iavf_aq_rc_to_posix - convert errors to user-land codes - * aq_ret: AdminQ handler error code can override aq_rc - * aq_rc: AdminQ firmware error code to convert + * @aq_ret: AdminQ handler error code can override aq_rc + * @aq_rc: AdminQ firmware error code to convert **/ static inline int iavf_aq_rc_to_posix(int aq_ret, int aq_rc) { |