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

From: Bagas Sanjaya
Date: Wed Jun 01 2022 - 03:27:51 EST


> 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