video: backlight: sky81452-backlight: Fix some kerneldoc issues
authorLee Jones <lee.jones@linaro.org>
Mon, 6 Jul 2020 07:44:21 +0000 (08:44 +0100)
committerLee Jones <lee.jones@linaro.org>
Wed, 8 Jul 2020 13:08:26 +0000 (14:08 +0100)
Firstly, all lines must begin with a '*'.  Secondly, arg descriptions
must be spelt correctly, so fix misspelling of 'gpioD_enable' and
'short_detecTion_threshold'

Fixes the following W=1 kernel build warning(s):

 drivers/video/backlight/sky81452-backlight.c:46: warning: bad line:                 If it is not defined, default name is lcd-backlight.
 drivers/video/backlight/sky81452-backlight.c:64: warning: Function parameter or member 'gpiod_enable' not described in 'sky81452_bl_platform_data'
 drivers/video/backlight/sky81452-backlight.c:64: warning: Function parameter or member 'short_detection_threshold' not described in 'sky81452_bl_platform_data'

Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
drivers/video/backlight/sky81452-backlight.c

index 83ccb3d..0ce1815 100644 (file)
 /**
  * struct sky81452_platform_data
  * @name:      backlight driver name.
              If it is not defined, default name is lcd-backlight.
- * @gpios_enable:GPIO descriptor which control EN pin
*             If it is not defined, default name is lcd-backlight.
+ * @gpiod_enable:GPIO descriptor which control EN pin
  * @enable:    Enable mask for current sink channel 1, 2, 3, 4, 5 and 6.
  * @ignore_pwm:        true if DPWMI should be ignored.
  * @dpwm_mode: true is DPWM dimming mode, otherwise Analog dimming mode.
  * @phase_shift:true is phase shift mode.
- * @short_detecion_threshold:  It should be one of 4, 5, 6 and 7V.
+ * @short_detection_threshold: It should be one of 4, 5, 6 and 7V.
  * @boost_current_limit:       It should be one of 2300, 2750mA.
  */
 struct sky81452_bl_platform_data {