| Message ID | 20240301092115.123092-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [-next] Input: Fix kernel-doc for xps2_of_probe function | expand |
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@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@amd.com> Thanks, Michal
On Fri, Mar 01, 2024 at 05:21:15PM +0800, 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@linux.alibaba.com> Applied, thank you.
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.
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> --- drivers/input/serio/xilinx_ps2.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)