staging: gpib: fix kernel-doc section for function usb_gpib_interface_clear()

gascoar · gregkh · commit 4ec9b9b584c9 · 2025-03-20T07:02:41.000-07:00
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>
diff --git a/drivers/staging/gpib/lpvo_usb_gpib/lpvo_usb_gpib.c b/drivers/staging/gpib/lpvo_usb_gpib/lpvo_usb_gpib.c
@@ -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

Original file line number	Diff line number	Diff line change
`@@ -621,7 +621,7 @@ static int usb_gpib_go_to_standby(struct gpib_board *board)`
`621`	`621`	`* usb_gpib_interface_clear() - Assert or de-assert IFC`
`622`	`622`	`*`
`623`	`623`	`* @board: the gpib_board data area for this gpib interface`
`624`		`- * assert: 1: assert IFC; 0: de-assert IFC`
	`624`	`+ * @assert: 1: assert IFC; 0: de-assert IFC`
`625`	`625`	`*`
`626`	`626`	`* Currently on the assert request we issue the lpvo IBZ`
`627`	`627`	`* command that cycles IFC low for 100 usec, then we ignore`