[PATCH -next] Input: Fix kernel-doc for xps2_of_probe function
Michal Simek
michal.simek at amd.com
Fri Mar 1 01:24:38 PST 2024
On 3/1/24 10:21, Yang Li wrote:
> 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 at linux.alibaba.com>
> ---
> drivers/input/serio/xilinx_ps2.c | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/drivers/input/serio/xilinx_ps2.c b/drivers/input/serio/xilinx_ps2.c
> index d8f9faf2b529..bb758346a33d 100644
> --- a/drivers/input/serio/xilinx_ps2.c
> +++ b/drivers/input/serio/xilinx_ps2.c
> @@ -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.
Reviewed-by: Michal Simek <michal.simek at amd.com>
Thanks,
Michal
More information about the linux-arm-kernel
mailing list