Re: [PATCH v1 1/1] gpiolib: Update the kernel documentation - add Return sections

From: Andy Shevchenko
Date: Fri Apr 05 2024 - 11:40:59 EST


On Fri, Apr 05, 2024 at 08:33:26AM -0700, Randy Dunlap wrote:
> On 4/5/24 8:27 AM, Andy Shevchenko wrote:
> > On Thu, Apr 04, 2024 at 09:10:09PM -0700, Randy Dunlap wrote:
> >> On 4/4/24 2:27 PM, Andy Shevchenko wrote:
> >>> $ scripts/kernel-doc -v -none -Wall drivers/gpio/gpiolib* 2>&1 | grep -w warning | wc -l
> >>> 67
> >>>
> >>> Fix these by adding Return sections. While at it, make sure all of
> >>> Return sections use the same style.

..

> >> I would use %true, %false, %NULL, %0, and %1 in a few places.
> >
> > Why? I specifically removed % from all of them, it's not so useful.
> > Do we have, btw, generated HTML with these % as an example to see
> > the difference. Maybe that helps to understand this better?
>
> The leading '%' just changes the font style of constants.
> I don't know of any HTML that compares them.

I meant to compare the (HTML) render to see the difference, but you already
explained that it adds/modifies <font> tag or so.

--
With Best Regards,
Andy Shevchenko