Kerneldoc syntax is used, but not complete. Descriptions required.
Prevents warnings like:
drivers/video/backlight/ili922x.c:298: warning: Function parameter or member 'spi' not described in 'ili922x_reg_dump'
Cc: <[email protected]>
Cc: Bartlomiej Zolnierkiewicz <[email protected]>
Cc: Software Engineering <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
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 cd41433b87aeb..26193f38234e7 100644
--- a/drivers/video/backlight/ili922x.c
+++ b/drivers/video/backlight/ili922x.c
@@ -295,6 +295,8 @@ static int ili922x_write(struct spi_device *spi, u8 reg, u16 value)
#ifdef DEBUG
/**
* ili922x_reg_dump - dump all registers
+ *
+ * @spi: pointer to the controller side proxy for an SPI slave device
*/
static void ili922x_reg_dump(struct spi_device *spi)
{
--
2.25.1
On Wed, Jun 24, 2020 at 03:57:18PM +0100, Lee Jones wrote:
> Kerneldoc syntax is used, but not complete. Descriptions required.
>
> Prevents warnings like:
>
> drivers/video/backlight/ili922x.c:298: warning: Function parameter or member 'spi' not described in 'ili922x_reg_dump'
>
> Cc: <[email protected]>
> Cc: Bartlomiej Zolnierkiewicz <[email protected]>
> Cc: Software Engineering <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>
> ---
> 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 cd41433b87aeb..26193f38234e7 100644
> --- a/drivers/video/backlight/ili922x.c
> +++ b/drivers/video/backlight/ili922x.c
> @@ -295,6 +295,8 @@ static int ili922x_write(struct spi_device *spi, u8 reg, u16 value)
> #ifdef DEBUG
> /**
> * ili922x_reg_dump - dump all registers
> + *
> + * @spi: pointer to the controller side proxy for an SPI slave device
Similar to previous... and I also noticed that there are several other
existing @spi descriptions in this file and it would be good to make
them consistent.
Daniel.
> */
> static void ili922x_reg_dump(struct spi_device *spi)
> {
> --
> 2.25.1
>
On Thu, 25 Jun 2020, Daniel Thompson wrote:
> On Wed, Jun 24, 2020 at 03:57:18PM +0100, Lee Jones wrote:
> > Kerneldoc syntax is used, but not complete. Descriptions required.
> >
> > Prevents warnings like:
> >
> > drivers/video/backlight/ili922x.c:298: warning: Function parameter or member 'spi' not described in 'ili922x_reg_dump'
> >
> > Cc: <[email protected]>
> > Cc: Bartlomiej Zolnierkiewicz <[email protected]>
> > Cc: Software Engineering <[email protected]>
> > Signed-off-by: Lee Jones <[email protected]>
> > ---
> > 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 cd41433b87aeb..26193f38234e7 100644
> > --- a/drivers/video/backlight/ili922x.c
> > +++ b/drivers/video/backlight/ili922x.c
> > @@ -295,6 +295,8 @@ static int ili922x_write(struct spi_device *spi, u8 reg, u16 value)
> > #ifdef DEBUG
> > /**
> > * ili922x_reg_dump - dump all registers
> > + *
> > + * @spi: pointer to the controller side proxy for an SPI slave device
>
> Similar to previous... and I also noticed that there are several other
> existing @spi descriptions in this file and it would be good to make
> them consistent.
I've fixed this and applied the patch.
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog