From patchwork Sat May 28 09:14:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12863958 X-Patchwork-Delegate: jikos@jikos.cz 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 48A30C433F5 for ; Sat, 28 May 2022 09:14:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232313AbiE1JOl (ORCPT ); Sat, 28 May 2022 05:14:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56966 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232279AbiE1JOj (ORCPT ); Sat, 28 May 2022 05:14:39 -0400 Received: from mail-pg1-x532.google.com (mail-pg1-x532.google.com [IPv6:2607:f8b0:4864:20::532]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8EA5A26A; Sat, 28 May 2022 02:14:37 -0700 (PDT) Received: by mail-pg1-x532.google.com with SMTP id q123so859996pgq.6; Sat, 28 May 2022 02:14:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=GURDLD8fq2AWOdGy1BHqDXdBjLx5bVXEyWSiOccXTFA=; b=YEYAbQLZVyGOPW5q4qCpmJz2/LnPnAd6qik6FWAHDEjH5YfqQwL3C6QGUoAOkObnbK HAbUdoX5X1ku9dx5nNVLj9RvhAwD7VeFPy9tiQFM6H8xjdmD8HWocqzxw3qqFBW1lyDY M4/TOtVySSw0pKdPboWBs5hHk5Crb6Zyx1my4xIoHb61AanhYhdU4jLW6I2Z5sYnF05R paOCT16OvCabwdzIiE4QKBVSBNAn82adwTlNO2KHaxCjyeDUuFSPkmL2m0ctdTlFwkes dhWi2y37HUu4X4z+miEAJOyl/vnqD2tjuHM/Vfq/LVg5eQ5BQ9u04tnaNSYVkG7NEt/0 gGdg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=GURDLD8fq2AWOdGy1BHqDXdBjLx5bVXEyWSiOccXTFA=; b=KTAcgflGTdGigP/fN2mdKVZugINro3oUW52vyulrFcS0hgueYuspT1b+JBwd89zi0F cDJB+wuqC2AWASuqeS9bDw3zsph/ukn0OhJTcBK1sZbZHSsuAClCyqaoKIhMeE2tGQOp NOZSY6o5EFMRQb2a8qPMzSJnhFHZ9MIGFIpbNk6kehUCTT4UNMqICK5mnnWYh1kCOPDw 5oNsioirSrahw7OsyDwm7qIQ0Fpj+x/gFnDCS/79ia4hbIxN2j3YWY2KD1N0Yg7lkpJ5 Gpihgung7F5h7gFElb4zD9zHq/tOANOSZ9RZepxt6ZVPxeUfAwOzkj6exWj5faPTQTYl XJoQ== X-Gm-Message-State: AOAM533whCPA6lGNHlkj5m7CKMd0BQSYnPPjSpKZb6RfVXfOPr7NciDB ZkIdRWRbJmTuEsXn35A4kfjBcwX2BIJ2Sez/ X-Google-Smtp-Source: ABdhPJyWJQoeIcudr0763uMq1YHoIpFW+NSB6/bA4tJRRtTuk9T/ssqTDu2E1yv15WgN8FH+cScgLQ== X-Received: by 2002:a65:6055:0:b0:3c6:adfd:5135 with SMTP id a21-20020a656055000000b003c6adfd5135mr40786271pgp.146.1653729276731; Sat, 28 May 2022 02:14:36 -0700 (PDT) Received: from debian.me (subs02-180-214-232-83.three.co.id. [180.214.232.83]) by smtp.gmail.com with ESMTPSA id l12-20020a170902f68c00b0016198062800sm5320179plg.161.2022.05.28.02.14.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 28 May 2022 02:14:36 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , kernel test robot , Nikolai Kondrashov , Jiri Kosina , Benjamin Tissoires , =?utf-8?b?Sm9zw6kgRXhw?= =?utf-8?b?w7NzaXRv?= , llvm@lists.linux.dev, linux-input@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 1/2] HID: uclogic: remove extraneous asterisk on uclogic_params_* static functions comments Date: Sat, 28 May 2022 16:14:02 +0700 Message-Id: <20220528091403.160169-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 In-Reply-To: <20220528091403.160169-1-bagasdotme@gmail.com> References: <20220528091403.160169-1-bagasdotme@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org *uclogic_params_pen_inrange_to_str(), uclogic_params_pen_hid_dbg(), and uclogic_params_frame_hid_dbg() are static functions but contain double-asterisk (/** */) comment, which confuses kernel-doc as public function for generating documentation. Remove the extraneous asterisk from these comments. Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/ Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function") Reported-by: kernel test robot Cc: Nikolai Kondrashov Cc: Jiri Kosina Cc: Benjamin Tissoires Cc: "José Expósito" Cc: llvm@lists.linux.dev Cc: linux-input@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- drivers/hid/hid-uclogic-params.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c index db838f16282d64..71501453de12e4 100644 --- a/drivers/hid/hid-uclogic-params.c +++ b/drivers/hid/hid-uclogic-params.c @@ -20,7 +20,7 @@ #include #include -/** +/* * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type * to a string. * @@ -44,7 +44,7 @@ static const char *uclogic_params_pen_inrange_to_str( } } -/** +/* * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. * * @hdev: The HID device the pen parameters describe. @@ -76,7 +76,7 @@ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, (pen->tilt_y_flipped ? "true" : "false")); } -/** +/* * Dump tablet interface frame parameters with hid_dbg(), indented with two * tabs. * From patchwork Sat May 28 09:14:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12863959 X-Patchwork-Delegate: jikos@jikos.cz 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4F9CCC433EF for ; Sat, 28 May 2022 09:14:47 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232349AbiE1JOo (ORCPT ); Sat, 28 May 2022 05:14:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57014 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232350AbiE1JOn (ORCPT ); Sat, 28 May 2022 05:14:43 -0400 Received: from mail-pf1-x433.google.com (mail-pf1-x433.google.com [IPv6:2607:f8b0:4864:20::433]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 084365FB0; Sat, 28 May 2022 02:14:41 -0700 (PDT) Received: by mail-pf1-x433.google.com with SMTP id y1so6306188pfr.6; Sat, 28 May 2022 02:14:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=2cmreXVkKeTuS3iLda3uDJCEUdvooYyM7QNARThfArQ=; b=VTRt1uLhMTgIvoICyNK1K4DvISkrJto6QUdz42wHaQhFckzhegvbpDenZo1DkDOsuP lECoEOynKmg/Ze93ddslExgRDFXN9ZEbbT1sN8I3ZE3dxVWd4hlEJojzEDtVC5S2ybDx O3M+kDI7BSFLOBRuRtDow343Wthn0enWane8a0D/6JK/s/DByaq1I/aGT/qZjQ7apeCh Ha8lnoT/XUfmfTN1KsCGh6lhI7O9pEP+07R/QL6uVc0mJWjbA7+kJsDHxnynuIKyVGN2 THFWA0HQz1gfwdpeePJEmsooJz2NNv2A39aBeDwiGXjIAuwoq8++Fuw5S7FjQsgxaBM2 fLCA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=2cmreXVkKeTuS3iLda3uDJCEUdvooYyM7QNARThfArQ=; b=I3zhliva6ngHBRPLd07FeJIx0YSD5BNEHZYkg16Y0IVNthuQlXrckA40YGWDy21CtI tGJ0UCAXkvsj1r1BHsMSEn54QPjdarr7makFXtI6Z5ZbokxIOWSIAYVxmT/0Ss2vX10X gzLo6l60K7YDramKWhGu9wQOCZyKjzCwRu9XGKiodYfmO2YpKqY0AMFy7w+5NH832gjH PxNxWGuW9oXFZSQ7taKN/JlGG1I/hKiPevA2LEkyC/LoWoGBCJgppYiTIYd6ipxe8AkC oR0JhxwWcI3ILk34XAVbN/q+WPFxQfd5Ux0fTXCOvOsUcCvy9US7vzMNsefHKJoOEbM5 bdZg== X-Gm-Message-State: AOAM533F6jXlcsiJZjCRJ8x5XB0nI9TyxkfC1xwQqIgltKwM2m3aDz8X UY9L3QHegzQYMvGNNeVUTtykz0iu+OzkSjbh X-Google-Smtp-Source: ABdhPJxTZ3//L0+n/S1b5h79f4IEubXD+U1hWPngiQJyYJKXN7Cu3aGrFpYqFoZGccOa0dTRsa6SPA== X-Received: by 2002:a05:6a00:15c5:b0:518:9848:4915 with SMTP id o5-20020a056a0015c500b0051898484915mr30768636pfu.62.1653729280076; Sat, 28 May 2022 02:14:40 -0700 (PDT) Received: from debian.me (subs02-180-214-232-83.three.co.id. [180.214.232.83]) by smtp.gmail.com with ESMTPSA id l12-20020a170902f68c00b0016198062800sm5320179plg.161.2022.05.28.02.14.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 28 May 2022 02:14:39 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , Nikolai Kondrashov , Jiri Kosina , Benjamin Tissoires , =?utf-8?b?Sm9zw6kgRXhw?= =?utf-8?b?w7NzaXRv?= , llvm@lists.linux.dev, linux-input@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 2/2] HID: uclogic: add missing function name in uclogic_params_hid_dbg() kernel-doc comment Date: Sat, 28 May 2022 16:14:03 +0700 Message-Id: <20220528091403.160169-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 In-Reply-To: <20220528091403.160169-1-bagasdotme@gmail.com> References: <20220528091403.160169-1-bagasdotme@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org uclogic_params_hid_dbg() is public void function. The comment for kernel-doc, however, lack its function name on short description, thus triggers "missing initial short description" warning. Add the function name to fix the warning. Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function") Cc: Nikolai Kondrashov Cc: Jiri Kosina Cc: Benjamin Tissoires Cc: "José Expósito" Cc: llvm@lists.linux.dev Cc: linux-input@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- drivers/hid/hid-uclogic-params.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c index 71501453de12e4..0319e3f1527f1d 100644 --- a/drivers/hid/hid-uclogic-params.c +++ b/drivers/hid/hid-uclogic-params.c @@ -102,7 +102,7 @@ static void uclogic_params_frame_hid_dbg( } /** - * Dump tablet interface parameters with hid_dbg(). + * uclogic_params_hid_dbg - Dump tablet interface parameters with hid_dbg(). * * @hdev: The HID device the parameters describe. * @params: The parameters to dump.