staging: vt6655: correct documentation warnings
authorEdmundo Carmona Antoranz <eantoranz@gmail.com>
Sun, 14 Mar 2021 14:59:42 +0000 (08:59 -0600)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sun, 14 Mar 2021 16:01:44 +0000 (17:01 +0100)
Both arguments to set_channel have changed their names and their
types. Correct the discrepancy in the function documentation to get
rid of four warnings:

drivers/staging/vt6655/channel.c:165: warning: Function parameter or member 'priv' not described in 'set_channel'
drivers/staging/vt6655/channel.c:165: warning: Function parameter or member 'ch' not described in 'set_channel'
drivers/staging/vt6655/channel.c:165: warning: Excess function parameter 'pDeviceHandler' description in 'set_channel'
drivers/staging/vt6655/channel.c:165: warning: Excess function parameter 'uConnectionChannel' description in 'set_channel'

Signed-off-by: Edmundo Carmona Antoranz <eantoranz@gmail.com>
Link: https://lore.kernel.org/r/20210314145943.1933245-2-eantoranz@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/vt6655/channel.c

index 889fc22..ba92b72 100644 (file)
@@ -155,8 +155,8 @@ void vnt_init_bands(struct vnt_private *priv)
 /**
  * set_channel() - Set NIC media channel
  *
- * @pDeviceHandler: The adapter to be set
- * @uConnectionChannel: Channel to be set
+ * @priv: The adapter to be set
+ * @ch: Channel to be set
  *
  * Return Value: true if succeeded; false if failed.
  *