ixgbevf: Fix kernel-doc format warnings

Recent checks added for formatting kernel-doc comments are causing warnings
if W= is run with a non-zero value.  This patch fixes function comments to
resolve warnings when W=1 is used.

Signed-off-by: Tony Nguyen <anthony.l.nguyen@intel.com>
Tested-by: Andrew Bowers <andrewx.bowers@intel.com>
Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
This commit is contained in:
Tony Nguyen 2017-12-04 11:28:31 -08:00 committed by Jeff Kirsher
parent 5ba643c6b8
commit e23cf38fca
2 changed files with 18 additions and 5 deletions

View File

@ -554,7 +554,6 @@ static void ixgbevf_process_skb_fields(struct ixgbevf_ring *rx_ring,
* ixgbevf_is_non_eop - process handling of non-EOP buffers * ixgbevf_is_non_eop - process handling of non-EOP buffers
* @rx_ring: Rx ring being processed * @rx_ring: Rx ring being processed
* @rx_desc: Rx descriptor for current buffer * @rx_desc: Rx descriptor for current buffer
* @skb: current socket buffer containing buffer in progress
* *
* This function updates next to clean. If the buffer is an EOP buffer * This function updates next to clean. If the buffer is an EOP buffer
* this function exits returning false, otherwise it will place the * this function exits returning false, otherwise it will place the
@ -2741,7 +2740,7 @@ void ixgbevf_update_stats(struct ixgbevf_adapter *adapter)
/** /**
* ixgbevf_service_timer - Timer Call-back * ixgbevf_service_timer - Timer Call-back
* @data: pointer to adapter cast into an unsigned long * @t: pointer to timer_list struct
**/ **/
static void ixgbevf_service_timer(struct timer_list *t) static void ixgbevf_service_timer(struct timer_list *t)
{ {
@ -2884,7 +2883,7 @@ static void ixgbevf_watchdog_link_is_down(struct ixgbevf_adapter *adapter)
/** /**
* ixgbevf_watchdog_subtask - worker thread to bring link up * ixgbevf_watchdog_subtask - worker thread to bring link up
* @work: pointer to work_struct containing our data * @adapter: board private structure
**/ **/
static void ixgbevf_watchdog_subtask(struct ixgbevf_adapter *adapter) static void ixgbevf_watchdog_subtask(struct ixgbevf_adapter *adapter)
{ {
@ -4364,6 +4363,7 @@ static void __exit ixgbevf_exit_module(void)
/** /**
* ixgbevf_get_hw_dev_name - return device name string * ixgbevf_get_hw_dev_name - return device name string
* used by hardware layer to print debugging information * used by hardware layer to print debugging information
* @hw: pointer to private hardware struct
**/ **/
char *ixgbevf_get_hw_dev_name(struct ixgbe_hw *hw) char *ixgbevf_get_hw_dev_name(struct ixgbe_hw *hw)
{ {

View File

@ -146,6 +146,7 @@ static s32 ixgbevf_reset_hw_vf(struct ixgbe_hw *hw)
/** /**
* Hyper-V variant; the VF/PF communication is through the PCI * Hyper-V variant; the VF/PF communication is through the PCI
* config space. * config space.
* @hw: pointer to private hardware struct
*/ */
static s32 ixgbevf_hv_reset_hw_vf(struct ixgbe_hw *hw) static s32 ixgbevf_hv_reset_hw_vf(struct ixgbe_hw *hw)
{ {
@ -303,7 +304,7 @@ static s32 ixgbevf_hv_set_uc_addr_vf(struct ixgbe_hw *hw, u32 index, u8 *addr)
/** /**
* ixgbevf_get_reta_locked - get the RSS redirection table (RETA) contents. * ixgbevf_get_reta_locked - get the RSS redirection table (RETA) contents.
* @adapter: pointer to the port handle * @hw: pointer to hardware structure
* @reta: buffer to fill with RETA contents. * @reta: buffer to fill with RETA contents.
* @num_rx_queues: Number of Rx queues configured for this port * @num_rx_queues: Number of Rx queues configured for this port
* *
@ -536,6 +537,8 @@ static s32 ixgbevf_update_mc_addr_list_vf(struct ixgbe_hw *hw,
/** /**
* Hyper-V variant - just a stub. * Hyper-V variant - just a stub.
* @hw: unused
* @netdev: unused
*/ */
static s32 ixgbevf_hv_update_mc_addr_list_vf(struct ixgbe_hw *hw, static s32 ixgbevf_hv_update_mc_addr_list_vf(struct ixgbe_hw *hw,
struct net_device *netdev) struct net_device *netdev)
@ -584,6 +587,8 @@ static s32 ixgbevf_update_xcast_mode(struct ixgbe_hw *hw, int xcast_mode)
/** /**
* Hyper-V variant - just a stub. * Hyper-V variant - just a stub.
* @hw: unused
* @xcast_mode: unused
*/ */
static s32 ixgbevf_hv_update_xcast_mode(struct ixgbe_hw *hw, int xcast_mode) static s32 ixgbevf_hv_update_xcast_mode(struct ixgbe_hw *hw, int xcast_mode)
{ {
@ -626,6 +631,10 @@ mbx_err:
/** /**
* Hyper-V variant - just a stub. * Hyper-V variant - just a stub.
* @hw: unused
* @vlan: unused
* @vind: unused
* @vlan_on: unused
*/ */
static s32 ixgbevf_hv_set_vfta_vf(struct ixgbe_hw *hw, u32 vlan, u32 vind, static s32 ixgbevf_hv_set_vfta_vf(struct ixgbe_hw *hw, u32 vlan, u32 vind,
bool vlan_on) bool vlan_on)
@ -655,7 +664,7 @@ static s32 ixgbevf_setup_mac_link_vf(struct ixgbe_hw *hw,
* @hw: pointer to hardware structure * @hw: pointer to hardware structure
* @speed: pointer to link speed * @speed: pointer to link speed
* @link_up: true is link is up, false otherwise * @link_up: true is link is up, false otherwise
* @autoneg_wait_to_complete: true when waiting for completion is needed * @autoneg_wait_to_complete: unused
* *
* Reads the links register to determine if link is up and the current speed * Reads the links register to determine if link is up and the current speed
**/ **/
@ -740,6 +749,10 @@ out:
/** /**
* Hyper-V variant; there is no mailbox communication. * Hyper-V variant; there is no mailbox communication.
* @hw: pointer to private hardware struct
* @speed: pointer to link speed
* @link_up: true is link is up, false otherwise
* @autoneg_wait_to_complete: unused
*/ */
static s32 ixgbevf_hv_check_mac_link_vf(struct ixgbe_hw *hw, static s32 ixgbevf_hv_check_mac_link_vf(struct ixgbe_hw *hw,
ixgbe_link_speed *speed, ixgbe_link_speed *speed,