Skip to contentSkip to conversation

phy: fix kdoc warning

PATCH Applied Jakub Kicinski 1 participant 2 messages Dec 15, 2020 – Dec 16, 2020

Subsystems (3)
lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH 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'

---
 include/linux/phy.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/linux/phy.h +2 -1
index 381a95732b6a..9effb511acde 100644
@@ -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
author maintainer Applied
#1 lore raw
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'

Applied.