Thread (28 messages) 28 messages, 3 authors, 2020-07-06

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

From: Daniel Thompson <hidden>
Date: 2020-06-25 09:43:25
Also in: dri-devel, linux-fbdev, lkml, stable

On Wed, Jun 24, 2020 at 03:57:18PM +0100, Lee Jones wrote:
quoted hunk ↗ jump to hunk
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: <redacted>
Cc: Bartlomiej Zolnierkiewicz <redacted>
Cc: Software Engineering <redacted>
Signed-off-by: Lee Jones <redacted>
---
 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
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help