From patchwork Tue May 31 09:28:17 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12865197 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 19DB9C4332F for ; Tue, 31 May 2022 09:29:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245226AbiEaJ3O (ORCPT ); Tue, 31 May 2022 05:29:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47174 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S245279AbiEaJ3K (ORCPT ); Tue, 31 May 2022 05:29:10 -0400 Received: from mail-pg1-x534.google.com (mail-pg1-x534.google.com [IPv6:2607:f8b0:4864:20::534]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5A32F980A8; Tue, 31 May 2022 02:28:47 -0700 (PDT) Received: by mail-pg1-x534.google.com with SMTP id q123so7271775pgq.6; Tue, 31 May 2022 02:28:47 -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:mime-version :content-transfer-encoding; bh=ovlQV07b/85+mO2OCXKW/11MoYcvf02O+pSiKdhkCZM=; b=FWEkNweQ57edkYWJKbyGu4pVyAWkpBV58kd5VWFfolSszAKdAUeemBTAqkKI9DnjOC FYViRDoqnWi8S5dLzsKApNjnxzhHIr1Rdq+PrNKFxAXmx4UO7CSJrEhZn73XTeM2zOtL HIC6G4VvXALeg4UsYhYgeRnqxG4JHpU/o1FG9BCZ6vOoCAYWsqoJEZKParR7pf8UGYdo 20ZkrVmhEZRj90n8L/k2oFS8bS7tFpD0dx8ws2csMT49P5ZnjX//mdk0pO28bZqki9fH MRa3KDRzzWb95gWM+ILAb1ZF6479Nzp8JeeBouymxLJf6eAaQsrC/53ZBXNrYABD5yFu QxBA== 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:mime-version :content-transfer-encoding; bh=ovlQV07b/85+mO2OCXKW/11MoYcvf02O+pSiKdhkCZM=; b=CO9txxNRnwQAeos/QzHoOs+Hn9P9MyjmKFbeSGbIqPvjbU9f28J/ZaMT1vvk+fjYBV JSzuaziJ8grgLzloWyhpjPaQ6YA/MnTYgvz9Uhyw4oYl33jKNRT3h4SMRnrNW6/Pwlzx TA0zpz1/8rWhquXLBcKaMQmR0koY4QcWtzWE8N3y4ZOzgbF90epiIjxQPUmHDFdcpObL c6VCceTs3IuaY9Pwzs7MvrXQB77Fl3IT+SGlQBja0iGf08k4W+AqruGJE2VnHaGtqQ5q cq9QyPr+MVDjQIK9hb9lUMV0TF2BOpfe7/XfnMkj+WrcEEhARpimRPsaDYn+i6uxP/3T +3ag== X-Gm-Message-State: AOAM533tJ/zl2ZSBwWuz1TZo3kwnQuKXs+sSa+GRCNPWFl3n+KkfcN9N zzbU4Zxac+C3/z1kvmPBS84/ZIWhp0g= X-Google-Smtp-Source: ABdhPJwxVJLUZd58TQh/Bx7hRuzo8leLW4V6ciNU8WD1VtQjP5zYKpQAUNUqgp+pqneF6TMjRoEFvw== X-Received: by 2002:a62:6144:0:b0:51b:99a7:5164 with SMTP id v65-20020a626144000000b0051b99a75164mr1201085pfb.61.1653989326462; Tue, 31 May 2022 02:28:46 -0700 (PDT) Received: from debian.me (subs32-116-206-28-1.three.co.id. [116.206.28.1]) by smtp.gmail.com with ESMTPSA id g80-20020a625253000000b0051b9d27091bsm379905pfb.76.2022.05.31.02.28.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 31 May 2022 02:28:45 -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, stable@vger.kernel.org, linux-input@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers Date: Tue, 31 May 2022 16:28:17 +0700 Message-Id: <20220531092817.13894-1-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found 6 warnings for hid_dbg() wrapper functions below: drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line: * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Dump tablet interface frame parameters with hid_dbg(), indented with two drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line: * Dump tablet interface frame parameters with hid_dbg(), indented with two drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Dump tablet interface parameters with hid_dbg(). drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line: * Dump tablet interface parameters with hid_dbg(). One of them is reported by kernel test robot. Fix these warnings by properly format kernel-doc comment for these functions. 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: stable@vger.kernel.org # v5.18 Cc: linux-input@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya Tested-by: Randy Dunlap Acked-by: Randy Dunlap Tested-by: José Expósito --- Changes since v1 [1]: - Approach the warning by fixing kernel-doc comments formatting (suggested by Jonathan Corbet) [1]: https://lore.kernel.org/linux-doc/20220528091403.160169-1-bagasdotme@gmail.com/ drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) base-commit: 8ab2afa23bd197df47819a87f0265c0ac95c5b6a diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c index db838f16282d64..647bbd3e000e2f 100644 --- a/drivers/hid/hid-uclogic-params.c +++ b/drivers/hid/hid-uclogic-params.c @@ -23,11 +23,11 @@ /** * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type * to a string. - * * @inrange: The in-range reporting type to convert. * - * Returns: - * The string representing the type, or NULL if the type is unknown. + * Return: + * * The string representing the type, or + * * NULL if the type is unknown. */ static const char *uclogic_params_pen_inrange_to_str( enum uclogic_params_pen_inrange inrange) @@ -45,10 +45,12 @@ static const char *uclogic_params_pen_inrange_to_str( } /** - * Dump tablet interface pen parameters with hid_dbg(), indented with one tab. - * + * uclogic_params_pen_hid_dbg() - Dump tablet interface pen parameters * @hdev: The HID device the pen parameters describe. * @pen: The pen parameters to dump. + * + * Dump tablet interface pen parameters with hid_dbg(). The dump is indented + * with a tab. */ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, const struct uclogic_params_pen *pen) @@ -77,11 +79,12 @@ static void uclogic_params_pen_hid_dbg(const struct hid_device *hdev, } /** - * Dump tablet interface frame parameters with hid_dbg(), indented with two - * tabs. - * + * uclogic_params_frame_hid_dbg() - Dump tablet interface frame parameters * @hdev: The HID device the pen parameters describe. * @frame: The frame parameters to dump. + * + * Dump tablet interface frame parameters with hid_dbg(). The dump is + * indented with two tabs. */ static void uclogic_params_frame_hid_dbg( const struct hid_device *hdev, @@ -102,10 +105,11 @@ static void uclogic_params_frame_hid_dbg( } /** - * Dump tablet interface parameters with hid_dbg(). - * + * uclogic_params_hid_dbg() - Dump tablet interface parameters * @hdev: The HID device the parameters describe. * @params: The parameters to dump. + * + * Dump tablet interface parameters with hid_dbg(). */ void uclogic_params_hid_dbg(const struct hid_device *hdev, const struct uclogic_params *params)