[PATCH] backlight: lp855x: fix lp855x.h kernel-doc warnings

[PATCH] backlight: lp855x: fix lp855x.h kernel-doc warnings

[Randy Dunlap]

Add a missing struct short description and a missing leading " *" to
lp855x.h to avoid kernel-doc warnings:

Warning: include/linux/platform_data/lp855x.h:126 missing initial short
 description on line:
 * struct lp855x_platform_data
Warning: include/linux/platform_data/lp855x.h:131 bad line:
   Only valid when mode is PWM_BASED.

Fixes: 7be865ab8634 ("backlight: new backlight driver for LP855x devices")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Lee Jones <lee@kernel.org>
Cc: Daniel Thompson <danielt@kernel.org>
Cc: Jingoo Han <jingoohan1@gmail.com>
Cc: dri-devel@lists.freedesktop.org
---
 include/linux/platform_data/lp855x.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20251107.orig/include/linux/platform_data/lp855x.h
+++ linux-next-20251107/include/linux/platform_data/lp855x.h
@@ -124,12 +124,12 @@ struct lp855x_rom_data {
 };
 
 /**
- * struct lp855x_platform_data
+ * struct lp855x_platform_data - lp855 platform-specific data
  * @name : Backlight driver name. If it is not defined, default name is set.
  * @device_control : value of DEVICE CONTROL register
  * @initial_brightness : initial value of backlight brightness
  * @period_ns : platform specific pwm period value. unit is nano.
-		Only valid when mode is PWM_BASED.
+ *		Only valid when mode is PWM_BASED.
  * @size_program : total size of lp855x_rom_data
  * @rom_data : list of new eeprom/eprom registers
  */

Re: [PATCH] backlight: lp855x: fix lp855x.h kernel-doc warnings

[Daniel Thompson]

On Mon, Nov 10, 2025 at 10:09:16PM -0800, Randy Dunlap wrote:
> Add a missing struct short description and a missing leading " *" to
> lp855x.h to avoid kernel-doc warnings:
>
> Warning: include/linux/platform_data/lp855x.h:126 missing initial short
>  description on line:
>  * struct lp855x_platform_data
> Warning: include/linux/platform_data/lp855x.h:131 bad line:
>    Only valid when mode is PWM_BASED.
>
> Fixes: 7be865ab8634 ("backlight: new backlight driver for LP855x devices")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Daniel Thompson (RISCstar) <danielt@kernel.org>


Daniel.

Re: (subset) [PATCH] backlight: lp855x: fix lp855x.h kernel-doc warnings

[Lee Jones]

On Mon, 10 Nov 2025 22:09:16 -0800, Randy Dunlap wrote:
> Add a missing struct short description and a missing leading " *" to
> lp855x.h to avoid kernel-doc warnings:
> 
> Warning: include/linux/platform_data/lp855x.h:126 missing initial short
>  description on line:
>  * struct lp855x_platform_data
> Warning: include/linux/platform_data/lp855x.h:131 bad line:
>    Only valid when mode is PWM_BASED.
> 
> [...]

Applied, thanks!

[1/1] backlight: lp855x: fix lp855x.h kernel-doc warnings
      commit: 1704e206cb98c5e43af1483e3b07450055a31008

--
Lee Jones [李琼斯]