Re: [PATCH v2 6/8] iio: core: Fix issues and style of the comments

From: andy . shevchenko
Date: Fri Jul 21 2023 - 17:37:48 EST


Fri, Jul 21, 2023 at 01:48:34PM -0700, Randy Dunlap kirjoitti:
> On 7/21/23 10:00, Andy Shevchenko wrote:

...

> > - * Return: 0 for successful release
> > + * Returns: 0 for successful release.

> As documented in Documentation/doc-guide/kernel-doc.rst:
> The return value, if any, should be described in a dedicated section
> named ``Return``.
>
> However, as you (and I) have found, "Returns:" also works as a section name.

Plural allowed for some section(s):
'\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$'

> Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thank you!

--
With Best Regards,
Andy Shevchenko