From mboxrd@z Thu Jan 1 00:00:00 1970 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 4C5A7C4332F for ; Wed, 1 Jun 2022 12:19:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1352209AbiFAMTK (ORCPT ); Wed, 1 Jun 2022 08:19:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41654 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1352226AbiFAMTH (ORCPT ); Wed, 1 Jun 2022 08:19:07 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CDBC85D5F2; Wed, 1 Jun 2022 05:19:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date:Message-ID:Sender :Reply-To:Content-ID:Content-Description; bh=E0ASuyIt3D/v/vJP2nisxwtwS8OQ6l/WjEuhFtT6iTA=; b=NYl34IC7oQjJCRRq3a7dZ1MxBy tA+6kILU8H4IQgKhQHo4jhzTTnPWy2z5cPt6qPbyBRyDd6MScbewtKsOjBKFfO0B4KGgULeNwBtkw mwpm/rezTymMsj8M+K4l6tTKCLrlpdzUU9IpjReeFfOUt4/AwBdmqtOKYs/nSfL5vP/eUBbnPoV6j uAyN+gVAcWSVQKP1TCAF3bselOe4k3bc0nKIlz0nsLV10TsASyKZWSYJSb6VKB9jQmiAzp9VPm2jB DF3pCzCDTxSLDkcmtMFYK7i4P6XrqWJ1nAehm9M60WkBvJ0yNVufVIR7XDNB0+LAcsqKS8lZnmNAr Pnf0YJqg==; Received: from [2601:1c0:6280:3f0::aa0b] by casper.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1nwNJS-006GXo-Fj; Wed, 01 Jun 2022 12:18:59 +0000 Message-ID: <053f756b-fafa-e07a-4308-0a5de8dda595@infradead.org> Date: Wed, 1 Jun 2022 05:18:52 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.9.1 Subject: Re: [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers Content-Language: en-US To: Bagas Sanjaya Cc: linux-doc@vger.kernel.org, kernel test robot , Nikolai Kondrashov , Jiri Kosina , Benjamin Tissoires , =?UTF-8?B?Sm9zw6kgRXhww7NzaXRv?= , llvm@lists.linux.dev, stable@vger.kernel.org, linux-input@vger.kernel.org, linux-kernel@vger.kernel.org References: <20220531092817.13894-1-bagasdotme@gmail.com> <3995c3d8-395a-bd39-eebc-370bd1fca09c@infradead.org> From: Randy Dunlap In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-input@vger.kernel.org On 6/1/22 00:27, Bagas Sanjaya wrote: >> One note (nit) below: >> >>> drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++---------- >>> 1 file changed, 14 insertions(+), 10 deletions(-) >>> >>> 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. >> >> %NULL >> would be better here, but not required. >> > > Hi Randy, > > I don't see %NULL in Documentation/ (I git-grep-ed it but none found). > What should I do when I have to explain NULL in Return: section of > kernel-doc comment? In Documentation/doc-guide/kernel-doc.rst, section Highlights and cross-references: ``%CONST`` Name of a constant. (No cross-referencing, just formatting.) So '%' before a constant value just helps with the generated formatting of the output. It's just "prettier." No big deal. -- ~Randy