[5/8] backlight: ili922x: Add missing kerneldoc description for ili922x_reg_dump()'s arg

Message ID 20200624145721.2590327-6-lee.jones@linaro.org
State New
Headers show
Series
  • Untitled series #28416
Related show

Commit Message

Lee Jones June 24, 2020, 2:57 p.m.
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: <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(+)

-- 
2.25.1

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Comments

Daniel Thompson June 25, 2020, 9:43 a.m. | #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: <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 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

> 

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Patch

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)
 {