Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

iio: adc: qcom-vadc-common: fix vadc_scale_fn_type kernel-doc

Fix multiple warnings in enum vadc_scale_fn_type by adding a leading
'@' to the kernel-doc descriptions.

Fixed 14 warnings in this one enum, such as:
Warning: include/linux/iio/adc/qcom-vadc-common.h:123 Enum value
'SCALE_DEFAULT' not described in enum 'vadc_scale_fn_type'
Warning: ../include/linux/iio/adc/qcom-vadc-common.h:123 Enum value
'SCALE_THERM_100K_PULLUP' not described in enum 'vadc_scale_fn_type'
Warning: ../include/linux/iio/adc/qcom-vadc-common.h:123 Enum value
'SCALE_PMIC_THERM' not described in enum 'vadc_scale_fn_type'

Also prevent the warning on SCALE_HW_CALIB_INVALID by marking it
"private:" so that kernel-doc notation is not needed for it.

This leaves only one warning here, which I don't know the
appropriate description of:
qcom-vadc-common.h:125: warning: Enum value
'SCALE_HW_CALIB_PMIC_THERM_PM7' not described in enum 'vadc_scale_fn_type'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

authored by

Randy Dunlap and committed by
Jonathan Cameron
c5ebcc80 59795109

+14 -13
+14 -13
include/linux/iio/adc/qcom-vadc-common.h
··· 83 83 /** 84 84 * enum vadc_scale_fn_type - Scaling function to convert ADC code to 85 85 * physical scaled units for the channel. 86 - * SCALE_DEFAULT: Default scaling to convert raw adc code to voltage (uV). 87 - * SCALE_THERM_100K_PULLUP: Returns temperature in millidegC. 86 + * @SCALE_DEFAULT: Default scaling to convert raw adc code to voltage (uV). 87 + * @SCALE_THERM_100K_PULLUP: Returns temperature in millidegC. 88 88 * Uses a mapping table with 100K pullup. 89 - * SCALE_PMIC_THERM: Returns result in milli degree's Centigrade. 90 - * SCALE_XOTHERM: Returns XO thermistor voltage in millidegC. 91 - * SCALE_PMI_CHG_TEMP: Conversion for PMI CHG temp 92 - * SCALE_HW_CALIB_DEFAULT: Default scaling to convert raw adc code to 89 + * @SCALE_PMIC_THERM: Returns result in milli degree's Centigrade. 90 + * @SCALE_XOTHERM: Returns XO thermistor voltage in millidegC. 91 + * @SCALE_PMI_CHG_TEMP: Conversion for PMI CHG temp 92 + * @SCALE_HW_CALIB_DEFAULT: Default scaling to convert raw adc code to 93 93 * voltage (uV) with hardware applied offset/slope values to adc code. 94 - * SCALE_HW_CALIB_THERM_100K_PULLUP: Returns temperature in millidegC using 94 + * @SCALE_HW_CALIB_THERM_100K_PULLUP: Returns temperature in millidegC using 95 95 * lookup table. The hardware applies offset/slope to adc code. 96 - * SCALE_HW_CALIB_XOTHERM: Returns XO thermistor voltage in millidegC using 96 + * @SCALE_HW_CALIB_XOTHERM: Returns XO thermistor voltage in millidegC using 97 97 * 100k pullup. The hardware applies offset/slope to adc code. 98 - * SCALE_HW_CALIB_THERM_100K_PU_PM7: Returns temperature in millidegC using 98 + * @SCALE_HW_CALIB_THERM_100K_PU_PM7: Returns temperature in millidegC using 99 99 * lookup table for PMIC7. The hardware applies offset/slope to adc code. 100 - * SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade. 100 + * @SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade. 101 101 * The hardware applies offset/slope to adc code. 102 - * SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade. 102 + * @SCALE_HW_CALIB_PMIC_THERM: Returns result in milli degree's Centigrade. 103 103 * The hardware applies offset/slope to adc code. This is for PMIC7. 104 - * SCALE_HW_CALIB_PM5_CHG_TEMP: Returns result in millidegrees for PMIC5 104 + * @SCALE_HW_CALIB_PM5_CHG_TEMP: Returns result in millidegrees for PMIC5 105 105 * charger temperature. 106 - * SCALE_HW_CALIB_PM5_SMB_TEMP: Returns result in millidegrees for PMIC5 106 + * @SCALE_HW_CALIB_PM5_SMB_TEMP: Returns result in millidegrees for PMIC5 107 107 * SMB1390 temperature. 108 108 */ 109 109 enum vadc_scale_fn_type { ··· 120 120 SCALE_HW_CALIB_PMIC_THERM_PM7, 121 121 SCALE_HW_CALIB_PM5_CHG_TEMP, 122 122 SCALE_HW_CALIB_PM5_SMB_TEMP, 123 + /* private: */ 123 124 SCALE_HW_CALIB_INVALID, 124 125 }; 125 126