From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Randy Dunlap <rdunlap@infradead.org>
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>,
"José Expósito" <jose.exposito89@gmail.com>,
llvm@lists.linux.dev, stable@vger.kernel.org,
linux-input@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers
Date: Wed, 1 Jun 2022 14:27:42 +0700 [thread overview]
Message-ID: <YpcU7qeOtShFx8xR@debian.me> (raw)
In-Reply-To: <3995c3d8-395a-bd39-eebc-370bd1fca09c@infradead.org>
> 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?
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-06-01 7:27 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-31 9:28 [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers Bagas Sanjaya
2022-05-31 15:52 ` Randy Dunlap
2022-06-01 7:27 ` Bagas Sanjaya [this message]
2022-06-01 12:18 ` Randy Dunlap
2022-06-01 18:00 ` José Expósito
2022-06-02 8:25 ` Bagas Sanjaya
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YpcU7qeOtShFx8xR@debian.me \
--to=bagasdotme@gmail.com \
--cc=benjamin.tissoires@redhat.com \
--cc=jikos@kernel.org \
--cc=jose.exposito89@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=llvm@lists.linux.dev \
--cc=rdunlap@infradead.org \
--cc=spbnick@gmail.com \
--cc=stable@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).