History

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'

Randy Dunlap committed 8 months ago

Commit 3350c2b1 parent c55b84f1 file · +7 −7Browse files

Showing the changes to include/linux/platform_data (1 of 1 file). Show all

Unified · Split

include/linux/platform_data/mlxreg.h+7−7
@@ -13,10 +13,10 @@ · 12 unmodified lines
13/**13/**
14 * enum mlxreg_wdt_type - type of HW watchdog14 * enum mlxreg_wdt_type - type of HW watchdog
15 *15 *
16 * TYPE1 HW watchdog implementation exist in old systems.16 * @MLX_WDT_TYPE1: HW watchdog implementation in old systems.
17 * All new systems have TYPE2 HW watchdog.17 * @MLX_WDT_TYPE2: All new systems have TYPE2 HW watchdog.
18 * TYPE3 HW watchdog can exist on all systems with new CPLD.18 * @MLX_WDT_TYPE3: HW watchdog that can exist on all systems with new CPLD.
19 * TYPE3 is selected by WD capability bit.19 * TYPE3 is selected by WD capability bit.
20 */20 */
21enum mlxreg_wdt_type {21enum mlxreg_wdt_type {
22 MLX_WDT_TYPE1,22 MLX_WDT_TYPE1,
@@ -35,7 +35,7 @@ enum mlxreg_wdt_type { · 12 unmodified lines
35 * @MLXREG_HOTPLUG_LC_SYNCED: entry for line card synchronization events, coming35 * @MLXREG_HOTPLUG_LC_SYNCED: entry for line card synchronization events, coming
36 * after hardware-firmware synchronization handshake;36 * after hardware-firmware synchronization handshake;
37 * @MLXREG_HOTPLUG_LC_READY: entry for line card ready events, indicating line card37 * @MLXREG_HOTPLUG_LC_READY: entry for line card ready events, indicating line card
38 PHYs ready / unready state;38 * PHYs ready / unready state;
39 * @MLXREG_HOTPLUG_LC_ACTIVE: entry for line card active events, indicating firmware39 * @MLXREG_HOTPLUG_LC_ACTIVE: entry for line card active events, indicating firmware
40 * availability / unavailability for the ports on line card;40 * availability / unavailability for the ports on line card;
41 * @MLXREG_HOTPLUG_LC_THERMAL: entry for line card thermal shutdown events, positive41 * @MLXREG_HOTPLUG_LC_THERMAL: entry for line card thermal shutdown events, positive
@@ -123,8 +123,8 @@ struct mlxreg_hotplug_device { · 81 unmodified lines
123 * @reg_pwr: attribute power register;123 * @reg_pwr: attribute power register;
124 * @reg_ena: attribute enable register;124 * @reg_ena: attribute enable register;
125 * @mode: access mode;125 * @mode: access mode;
126 * @np - pointer to node platform associated with attribute;126 * @np: pointer to node platform associated with attribute;
127 * @hpdev - hotplug device data;127 * @hpdev: hotplug device data;
128 * @notifier: pointer to event notifier block;128 * @notifier: pointer to event notifier block;
129 * @health_cntr: dynamic device health indication counter;129 * @health_cntr: dynamic device health indication counter;
130 * @attached: true if device has been attached after good health indication;130 * @attached: true if device has been attached after good health indication;