Re: [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers

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