Skip to content

Commit 3350c2b

Browse files
rddunlapij-intel
authored andcommitted
platform_data/mlxreg: mlxreg.h: fix all kernel-doc warnings
Use the correct kernel-doc format & notation to eliminate kernel-doc warnings: Warning: include/linux/platform_data/mlxreg.h:24 Enum value 'MLX_WDT_TYPE1' not described in enum 'mlxreg_wdt_type' Warning: include/linux/platform_data/mlxreg.h:24 Enum value 'MLX_WDT_TYPE2' not described in enum 'mlxreg_wdt_type' Warning: include/linux/platform_data/mlxreg.h:24 Enum value 'MLX_WDT_TYPE3' not described in enum 'mlxreg_wdt_type' Warning: include/linux/platform_data/mlxreg.h:37 bad line: PHYs ready / unready state; Warning: include/linux/platform_data/mlxreg.h:153 struct member 'np' not described in 'mlxreg_core_data' Warning: include/linux/platform_data/mlxreg.h:153 struct member 'hpdev' not described in 'mlxreg_core_data' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://patch.msgid.link/20260226051232.549537-1-rdunlap@infradead.org Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
1 parent c55b84f commit 3350c2b

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

include/linux/platform_data/mlxreg.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
/**
1414
* enum mlxreg_wdt_type - type of HW watchdog
1515
*
16-
* TYPE1 HW watchdog implementation exist in old systems.
17-
* All new systems have TYPE2 HW watchdog.
18-
* TYPE3 HW watchdog can exist on all systems with new CPLD.
19-
* TYPE3 is selected by WD capability bit.
16+
* @MLX_WDT_TYPE1: HW watchdog implementation in old systems.
17+
* @MLX_WDT_TYPE2: All new systems have TYPE2 HW watchdog.
18+
* @MLX_WDT_TYPE3: HW watchdog that can exist on all systems with new CPLD.
19+
* TYPE3 is selected by WD capability bit.
2020
*/
2121
enum mlxreg_wdt_type {
2222
MLX_WDT_TYPE1,
@@ -35,7 +35,7 @@ enum mlxreg_wdt_type {
3535
* @MLXREG_HOTPLUG_LC_SYNCED: entry for line card synchronization events, coming
3636
* after hardware-firmware synchronization handshake;
3737
* @MLXREG_HOTPLUG_LC_READY: entry for line card ready events, indicating line card
38-
PHYs ready / unready state;
38+
* PHYs ready / unready state;
3939
* @MLXREG_HOTPLUG_LC_ACTIVE: entry for line card active events, indicating firmware
4040
* availability / unavailability for the ports on line card;
4141
* @MLXREG_HOTPLUG_LC_THERMAL: entry for line card thermal shutdown events, positive
@@ -123,8 +123,8 @@ struct mlxreg_hotplug_device {
123123
* @reg_pwr: attribute power register;
124124
* @reg_ena: attribute enable register;
125125
* @mode: access mode;
126-
* @np - pointer to node platform associated with attribute;
127-
* @hpdev - hotplug device data;
126+
* @np: pointer to node platform associated with attribute;
127+
* @hpdev: hotplug device data;
128128
* @notifier: pointer to event notifier block;
129129
* @health_cntr: dynamic device health indication counter;
130130
* @attached: true if device has been attached after good health indication;

0 commit comments

Comments
 (0)