]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
backlight: lp855x: Fix lp855x.h kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 11 Nov 2025 06:09:16 +0000 (22:09 -0800)
committerLee Jones <lee@kernel.org>
Tue, 25 Nov 2025 12:54:32 +0000 (12:54 +0000)
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>
Link: https://patch.msgid.link/20251111060916.1995920-1-rdunlap@infradead.org
Signed-off-by: Lee Jones <lee@kernel.org>
include/linux/platform_data/lp855x.h

index ab222dd05bbc2554f2a0426d107b14d54068dd1b..3b4a891acefe9350fee7c3e4457a54ca18e72d0c 100644 (file)
@@ -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
  */