Input: xilinx_ps2 - fix kernel-doc for xps2_of_probe function
authorYang Li <yang.lee@linux.alibaba.com>
Sun, 3 Mar 2024 23:02:08 +0000 (15:02 -0800)
committerDmitry Torokhov <dmitry.torokhov@gmail.com>
Sun, 3 Mar 2024 23:02:55 +0000 (15:02 -0800)
The existing comment block above the xps2_of_probe function
does not conform to the kernel-doc standard. This patch fixes the
documentation to match the expected kernel-doc format, which includes
a structured documentation header with param and return value.

Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Reviewed-by: Michal Simek <michal.simek@amd.com>
Link: https://lore.kernel.org/r/20240301092115.123092-1-yang.lee@linux.alibaba.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
drivers/input/serio/xilinx_ps2.c

index d8f9faf..bb75834 100644 (file)
@@ -219,8 +219,7 @@ static void sxps2_close(struct serio *pserio)
 
 /**
  * xps2_of_probe - probe method for the PS/2 device.
- * @of_dev:    pointer to OF device structure
- * @match:     pointer to the structure used for matching a device
+ * @ofdev:     pointer to OF device structure
  *
  * This function probes the PS/2 device in the device tree.
  * It initializes the driver data structure and the hardware.