phy: fix kdoc warning
Subsystems (3)
Jakub Kicinski
maintainerPATCH 1/1 phy: fix kdoc warning
Kdoc does not like it when multiline comment follows the networking style of starting right on the first line:
include/linux/phy.h:869: warning: Function parameter or member 'config_intr' not described in 'phy_driver'
Signed-off-by Jakub Kicinski <[email protected]>
--- include/linux/phy.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
include/linux/phy.h +2 -1
@@ -741,11 +741,12 @@ struct phy_driver {int (*aneg_done)(struct phy_device *phydev);/** @read_status: Determines the negotiated speed and duplex */ int (*read_status)(struct phy_device *phydev); -/** @config_intr: Enables or disables interrupts. +/** +* @config_intr: Enables or disables interrupts. * It should also clear any pending interrupts prior to enabling the * IRQs and after disabling them. */ int (*config_intr)(struct phy_device *phydev);
Signature · 1 line
2.26.2
Quoted 6 lines · On Mon, 14 Dec 2020 22:37:50 -0800 Jakub Kicinski wrote:
Kdoc does not like it when multiline comment follows the networking style of starting right on the first line:
include/linux/phy.h:869: warning: Function parameter or member 'config_intr' not described in 'phy_driver'Signed-off-by Jakub Kicinski <[email protected]>
Applied.