linux-kernel - Re: [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <053f756b-fafa-e07a-4308-0a5de8dda595@infradead.org>
Date:   Wed, 1 Jun 2022 05:18:52 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     linux-doc@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Nikolai Kondrashov <spbnick@...il.com>,
        Jiri Kosina <jikos@...nel.org>,
        Benjamin Tissoires <benjamin.tissoires@...hat.com>,
        José Expósito <jose.exposito89@...il.com>,
        llvm@...ts.linux.dev, stable@...r.kernel.org,
        linux-input@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] HID: uclogic: properly format kernel-doc comment for
 hid_dbg() wrappers



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