]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
leds: lm3692x: Fix kernel-doc for struct lm3692x_led
authorVivek BalachandharTN <vivek.balachandhar@gmail.com>
Mon, 1 Dec 2025 04:26:12 +0000 (04:26 +0000)
committerLee Jones <lee@kernel.org>
Thu, 8 Jan 2026 10:42:47 +0000 (10:42 +0000)
Building with W=1 reports several kernel-doc warnings in
drivers/leds/leds-lm3692x.c:

  Warning: leds-lm3692x.c:122 struct member 'boost_ctrl'
  not described in 'lm3692x_led'
  Warning: leds-lm3692x.c:122 struct member 'brightness_ctrl'
  not described in 'lm3692x_led'
  Warning: leds-lm3692x.c:122 struct member 'enabled'
  not described in 'lm3692x_led'

These fields were added to struct lm3692x_led but the corresponding
kernel-doc comment was not updated. Convert the kernel-doc block to
use the "@member: description" style consistently and document the
boost_ctrl, brightness_ctrl and enabled fields.

This keeps the documentation in sync with the implementation and
silences the W=1 warnings.

Signed-off-by: Vivek BalachandharTN <vivek.balachandhar@gmail.com>
Link: https://patch.msgid.link/20251201042612.2099239-1-vivek.balachandhar@gmail.com
Signed-off-by: Lee Jones <lee@kernel.org>
drivers/leds/leds-lm3692x.c

index c319ff4d70b2aace33bac9e8dbe0e6cb3f50a4f6..1d64ceb5ac859a5e80f4c8d1298a306af44b043f 100644 (file)
  * @regulator: LED supply regulator pointer
  * @led_enable: LED sync to be enabled
  * @model_id: Current device model ID enumerated
+ * @boost_ctrl: Cached configuration for the boost control register
+ * @brightness_ctrl: Cached configuration for brightness/brightness control
+ * @enabled: Cached enable state of the device
  */
 struct lm3692x_led {
        struct mutex lock;