lkml.org 
[lkml]   [2020]   [Jun]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 03/10] regulator: of_regulator: Add missing colon for rdev kerneldoc argument
On Thu, 25 Jun 2020, Mark Brown wrote:

> On Thu, Jun 25, 2020 at 05:36:07PM +0100, Lee Jones wrote:
> > Kerneldoc validation gets confused if syntax isn't "@.*: ".
> >
> > Adding the missing colons squashes the following W=1 warnings:
>
> > * of_check_coupling_data - Parse rdev's coupling properties and check data
> > * consistency
> > - * @rdev - pointer to regulator_dev whose data is checked
> > + * @rdev: - pointer to regulator_dev whose data is checked
>
> It shuts up the warning but are you sure this is going to get formatted
> well by the tools? We now have a - as the first character in the
> description which I'm guessing the tools are going to render which won't
> look great.

Happy to fix.

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

\
 
 \ /
  Last update: 2020-06-25 20:43    [W:0.133 / U:0.076 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site