From patchwork Fri Mar 1 09:21:15 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yang Li X-Patchwork-Id: 13578208 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 2EE62C5478C for ; Fri, 1 Mar 2024 09:21:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=QK8orVVU2JSn/fJSJXgSKsCLgK2LBCdiRRApn38153o=; b=Q0K56qH35u2qQm GFUzyIhGyMCIYuKrIDaEBV6GlBFLeYopLTDkYc77SzQsZocnFThQcLm0rsVXLVK4XLBYxLa6zgLm6 v5tJEnj6a1+sP/aV1vOcqCTG0RHSgQnMDhznCtZ9zXqaRqAc0O82Fyyc6Z8tTjiPWxFvwrtB51t07 9G42eQzAoZxmMYhntZf0H/KtLV/9vfkEO2XFhwPfw6BOpKGo9CDVcAgD/z1DbLY5MVaPaMJR9Sp+i glVpKEnTxYC0pOlZZQGErRkLU2ohwp6hVcFFZofDIDTqqhT/f4VrLIQczr66BcorYtmOlMdESbCtB 3EnVKItqZMNojcGtFCyQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1rfz5B-0000000H7aK-1VR8; Fri, 01 Mar 2024 09:21:33 +0000 Received: from out30-111.freemail.mail.aliyun.com ([115.124.30.111]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1rfz57-0000000H7VI-1UPC for linux-arm-kernel@lists.infradead.org; Fri, 01 Mar 2024 09:21:31 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.alibaba.com; s=default; t=1709284884; h=From:To:Subject:Date:Message-Id:MIME-Version; bh=k5QB3ze+6oWRr+6yyCjkOCe+0xDxHnLLwE8gCBdLC+k=; b=VSDqHusNCD8fQWG0eoNDOI6UIauFkQPl/YfCCQk2353EwtKrL8x28xPMlvp+sFQykhc9HVPLv2DelOfWPKe7s2H4h1/R+/NCIPbKQ9G9/Vylb5CaRfsrnZyqKCTx6gWE94LbaKekAyynTfnvP3JnocYnyCMTk+NobJ9rg4ARGhQ= X-Alimail-AntiSpam: AC=PASS;BC=-1|-1;BR=01201311R811e4;CH=green;DM=||false|;DS=||;FP=0|-1|-1|-1|0|-1|-1|-1;HT=ay29a033018046050;MF=yang.lee@linux.alibaba.com;NM=1;PH=DS;RN=6;SR=0;TI=SMTPD_---0W1azpUa_1709284881; Received: from localhost(mailfrom:yang.lee@linux.alibaba.com fp:SMTPD_---0W1azpUa_1709284881) by smtp.aliyun-inc.com; Fri, 01 Mar 2024 17:21:22 +0800 From: Yang Li To: dmitry.torokhov@gmail.com, michal.simek@amd.com Cc: linux-input@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Yang Li Subject: [PATCH -next] Input: Fix kernel-doc for xps2_of_probe function Date: Fri, 1 Mar 2024 17:21:15 +0800 Message-Id: <20240301092115.123092-1-yang.lee@linux.alibaba.com> X-Mailer: git-send-email 2.20.1.7.g153144c MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240301_012130_202509_A8623160 X-CRM114-Status: GOOD ( 12.15 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org 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 Reviewed-by: Michal Simek --- 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.