Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
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 <bagasdotme@gmail.com>
Cc:     linux-doc@vger.kernel.org, kernel test robot <lkp@intel.com>,
        Nikolai Kondrashov <spbnick@gmail.com>,
        Jiri Kosina <jikos@kernel.org>,
        Benjamin Tissoires <benjamin.tissoires@redhat.com>,
        =?UTF-8?B?Sm9zw6kgRXhww7NzaXRv?= <jose.exposito89@gmail.com>,
        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>
 <YpcU7qeOtShFx8xR@debian.me>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <YpcU7qeOtShFx8xR@debian.me>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk


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