]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
staging: gpib: fix kernel-doc section for function usb_gpib_interface_clear()
authorGaston Gonzalez <gascoar@gmail.com>
Wed, 5 Mar 2025 19:32:18 +0000 (16:32 -0300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 20 Mar 2025 14:02:41 +0000 (07:02 -0700)
Add '@' character in kernel-doc comment in order 'assert' to be picked as
argument by the kernel-doc compiler.

This change fix the following warning:

warning: Function parameter or struct member 'assert' not described in
'usb_gpib_interface_clear'

Signed-off-by: Gaston Gonzalez <gascoar@gmail.com>
Link: https://lore.kernel.org/r/20250305193614.39604-5-gascoar@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/gpib/lpvo_usb_gpib/lpvo_usb_gpib.c

index 7f3da11291f653fc6e7a35e0298fc5a95c1ea865..37d97cd0182276edb80f767eaa05384fd9bc6ea7 100644 (file)
@@ -621,7 +621,7 @@ static int usb_gpib_go_to_standby(struct gpib_board *board)
  * usb_gpib_interface_clear() - Assert or de-assert IFC
  *
  * @board:    the gpib_board data area for this gpib interface
- * assert:    1: assert IFC;  0: de-assert IFC
+ * @assert:   1: assert IFC;  0: de-assert IFC
  *
  *    Currently on the assert request we issue the lpvo IBZ
  *    command that cycles IFC low for 100 usec, then we ignore