archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-08 01:04:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

leds: lm3692x: Fix kernel-doc for struct lm3692x_led

Browse source 
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>
This commit is contained in:
Vivek BalachandharTN 2025-12-01 04:26:12 +00:00 • committed by Lee Jones
parent 8f0b4cce44
commit 101bc85a19
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
drivers/leds/leds-lm3692x.c
View file

@ -104,6 +104,9 @@
* @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;