diff mbox series

net: dsa: vitesse-vsc73xx: Convert to plain comments to avoid kerneldoc warnings

Message ID 20200705210508.893443-1-andrew@lunn.ch
State Accepted
Delegated to: David Miller
Headers show
Series net: dsa: vitesse-vsc73xx: Convert to plain comments to avoid kerneldoc warnings | expand

Commit Message

Andrew Lunn July 5, 2020, 9:05 p.m. UTC
The comments before struct vsc73xx_platform and struct vsc73xx_spi use
kerneldoc format, but then fail to document the members of these
structures. All the structure members are self evident, and the driver
has not other kerneldoc comments, so change these to plain comments to
avoid warnings.

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
---
 drivers/net/dsa/vitesse-vsc73xx-platform.c | 2 +-
 drivers/net/dsa/vitesse-vsc73xx-spi.c      | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Florian Fainelli July 5, 2020, 9:08 p.m. UTC | #1
On 7/5/2020 2:05 PM, Andrew Lunn wrote:
> The comments before struct vsc73xx_platform and struct vsc73xx_spi use
> kerneldoc format, but then fail to document the members of these
> structures. All the structure members are self evident, and the driver
> has not other kerneldoc comments, so change these to plain comments to
> avoid warnings.
> 
> Signed-off-by: Andrew Lunn <andrew@lunn.ch>

Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
David Miller July 5, 2020, 10:49 p.m. UTC | #2
From: Andrew Lunn <andrew@lunn.ch>
Date: Sun,  5 Jul 2020 23:05:08 +0200

> The comments before struct vsc73xx_platform and struct vsc73xx_spi use
> kerneldoc format, but then fail to document the members of these
> structures. All the structure members are self evident, and the driver
> has not other kerneldoc comments, so change these to plain comments to
> avoid warnings.
> 
> Signed-off-by: Andrew Lunn <andrew@lunn.ch>

Applied to net-next.
diff mbox series

Patch

diff --git a/drivers/net/dsa/vitesse-vsc73xx-platform.c b/drivers/net/dsa/vitesse-vsc73xx-platform.c
index 5e54a5726aa4..2a57f337b2a2 100644
--- a/drivers/net/dsa/vitesse-vsc73xx-platform.c
+++ b/drivers/net/dsa/vitesse-vsc73xx-platform.c
@@ -28,7 +28,7 @@ 
 #define VSC73XX_CMD_PLATFORM_SUBBLOCK_MASK		0xf
 #define VSC73XX_CMD_PLATFORM_REGISTER_SHIFT		2
 
-/**
+/*
  * struct vsc73xx_platform - VSC73xx Platform state container
  */
 struct vsc73xx_platform {
diff --git a/drivers/net/dsa/vitesse-vsc73xx-spi.c b/drivers/net/dsa/vitesse-vsc73xx-spi.c
index e73c8fcddc9f..81eca4a5781d 100644
--- a/drivers/net/dsa/vitesse-vsc73xx-spi.c
+++ b/drivers/net/dsa/vitesse-vsc73xx-spi.c
@@ -26,7 +26,7 @@ 
 #define VSC73XX_CMD_SPI_BLOCK_MASK		0x7
 #define VSC73XX_CMD_SPI_SUBBLOCK_MASK		0xf
 
-/**
+/*
  * struct vsc73xx_spi - VSC73xx SPI state container
  */
 struct vsc73xx_spi {