Messages in this thread | | | Date | Thu, 25 Jun 2020 10:40:51 +0100 | From | Daniel Thompson <> | Subject | Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args |
| |
On Wed, Jun 24, 2020 at 03:57:16PM +0100, Lee Jones wrote: > Kerneldoc syntax is used, but not complete. Descriptions required. > > Prevents warnings like: > > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 's' not described in 'CHECK_FREQ_REG' > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 'x' not described in 'CHECK_FREQ_REG' > > Cc: <stable@vger.kernel.org> > Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> > Cc: Software Engineering <sbabic@denx.de> > Signed-off-by: Lee Jones <lee.jones@linaro.org> > --- > drivers/video/backlight/ili922x.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c > index 9c5aa3fbb2842..8cb4b9d3c3bba 100644 > --- a/drivers/video/backlight/ili922x.c > +++ b/drivers/video/backlight/ili922x.c > @@ -107,6 +107,8 @@ > * lower frequency when the registers are read/written. > * The macro sets the frequency in the spi_transfer structure if > * the frequency exceeds the maximum value. > + * @s: pointer to controller side proxy for an SPI slave device
What's wrong with "a pointer to an SPI device"?
I am aware, having looked it up to find out what the above actually means, that this is how struct spi_device is described in its own kernel doc but quoting at that level of detail of both overkill and confusing.
Daniel.
> + * @x: pointer to the read/write buffer pair > */ > #define CHECK_FREQ_REG(s, x) \ > do { \ > -- > 2.25.1 >
| |