[PATCH net-next] phy: fix kdoc warning

[PATCH net-next] phy: fix kdoc warning

[Jakub Kicinski]

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 <kuba@kernel.org>
---
 include/linux/phy.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/linux/phy.h b/include/linux/phy.h
index 381a95732b6a..9effb511acde 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -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);
 
-- 
2.26.2

Re: [PATCH net-next] phy: fix kdoc warning

[Jakub Kicinski]

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 <kuba@kernel.org>

Applied.