[PATCH v2 05/10] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections

Andy Shevchenko andriy.shevchenko at linux.intel.com
Thu Aug 29 05:48:37 PDT 2024


On Thu, Aug 29, 2024 at 04:51:25PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for many documented
> functions in the regulator OF-specific code. These all have descriptions
> about the return values, just not in the format kernel-doc wants.
> 
> Convert these to use the proper "Return:" section header. The existing
> descriptions have been reworded and moved around to fit the grammar and
> formatting.

...

> - * Returns true if all conditions are met.
> + * Return: True if all conditions are met; false otherwise.

You used %NULL elsewhere, so this also can use references to the boolean
constants.

 * Return: %true if all conditions are met; %false otherwise.

-- 
With Best Regards,
Andy Shevchenko





More information about the linux-arm-kernel mailing list