mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Michal Simek <michal.simek@amd.com>
To: Yang Li <yang.lee@linux.alibaba.com>, dmitry.torokhov@gmail.com
Cc: linux-input@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH -next] Input: Fix kernel-doc for xps2_of_probe function
Date: Fri, 1 Mar 2024 10:24:38 +0100	[thread overview]
Message-ID: <39b4b28b-8061-4af3-9129-d05a6f050719@amd.com> (raw)
In-Reply-To: <20240301092115.123092-1-yang.lee@linux.alibaba.com>



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

  reply	other threads:[~2024-03-01  9:24 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-01  9:21 Yang Li
2024-03-01  9:24 ` Michal Simek [this message]
2024-03-03 23:03 ` Dmitry Torokhov

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=39b4b28b-8061-4af3-9129-d05a6f050719@amd.com \
    --to=michal.simek@amd.com \
    --cc=dmitry.torokhov@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=yang.lee@linux.alibaba.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®