All of lore.kernel.org
 help / color / mirror / Atom feed
From: Vinod Koul <vkoul@kernel.org>
To: Kishon Vijay Abraham I <kishon@ti.com>
Cc: linux-phy@lists.infradead.org, Vinod Koul <vkoul@kernel.org>,
	Roger Quadros <rogerq@ti.com>, Liam Beguin <lvb@xiphos.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style
Date: Sat, 20 Nov 2021 11:45:31 +0530	[thread overview]
Message-ID: <20211120061531.410771-2-vkoul@kernel.org> (raw)
In-Reply-To: <20211120061531.410771-1-vkoul@kernel.org>

The documentation uses incorrect style, so fix that.

drivers/phy/ti/phy-omap-usb2.c:102: warning: Function parameter or member 'comparator' not described in 'omap_usb2_set_comparator'

While at it, use a single line for function description

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
Changes in v2: use () for function names

 drivers/phy/ti/phy-omap-usb2.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/phy/ti/phy-omap-usb2.c b/drivers/phy/ti/phy-omap-usb2.c
index ebceb1520ce8..3a505fe5715a 100644
--- a/drivers/phy/ti/phy-omap-usb2.c
+++ b/drivers/phy/ti/phy-omap-usb2.c
@@ -89,9 +89,9 @@ static inline void omap_usb_writel(void __iomem *addr, unsigned int offset,
 }
 
 /**
- * omap_usb2_set_comparator - links the comparator present in the system with
- *	this phy
- * @comparator - the companion phy(comparator) for this phy
+ * omap_usb2_set_comparator() - links the comparator present in the system with this phy
+ *
+ * @comparator:  the companion phy(comparator) for this phy
  *
  * The phy companion driver should call this API passing the phy_companion
  * filled with set_vbus and start_srp to be used by usb phy.
-- 
2.31.1


-- 
linux-phy mailing list
linux-phy@lists.infradead.org
https://lists.infradead.org/mailman/listinfo/linux-phy

WARNING: multiple messages have this Message-ID (diff)
From: Vinod Koul <vkoul@kernel.org>
To: Kishon Vijay Abraham I <kishon@ti.com>
Cc: linux-phy@lists.infradead.org, Vinod Koul <vkoul@kernel.org>,
	Roger Quadros <rogerq@ti.com>, Liam Beguin <lvb@xiphos.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 2/2] phy: ti: omap-usb2: Fix the kernel-doc style
Date: Sat, 20 Nov 2021 11:45:31 +0530	[thread overview]
Message-ID: <20211120061531.410771-2-vkoul@kernel.org> (raw)
In-Reply-To: <20211120061531.410771-1-vkoul@kernel.org>

The documentation uses incorrect style, so fix that.

drivers/phy/ti/phy-omap-usb2.c:102: warning: Function parameter or member 'comparator' not described in 'omap_usb2_set_comparator'

While at it, use a single line for function description

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
Changes in v2: use () for function names

 drivers/phy/ti/phy-omap-usb2.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/phy/ti/phy-omap-usb2.c b/drivers/phy/ti/phy-omap-usb2.c
index ebceb1520ce8..3a505fe5715a 100644
--- a/drivers/phy/ti/phy-omap-usb2.c
+++ b/drivers/phy/ti/phy-omap-usb2.c
@@ -89,9 +89,9 @@ static inline void omap_usb_writel(void __iomem *addr, unsigned int offset,
 }
 
 /**
- * omap_usb2_set_comparator - links the comparator present in the system with
- *	this phy
- * @comparator - the companion phy(comparator) for this phy
+ * omap_usb2_set_comparator() - links the comparator present in the system with this phy
+ *
+ * @comparator:  the companion phy(comparator) for this phy
  *
  * The phy companion driver should call this API passing the phy_companion
  * filled with set_vbus and start_srp to be used by usb phy.
-- 
2.31.1


  reply	other threads:[~2021-11-20  6:15 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-20  6:15 [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix kernel-doc style Vinod Koul
2021-11-20  6:15 ` Vinod Koul
2021-11-20  6:15 ` Vinod Koul [this message]
2021-11-20  6:15   ` [PATCH v2 2/2] phy: ti: omap-usb2: Fix the " Vinod Koul
2021-11-20 17:21   ` Liam Beguin
2021-11-20 17:21     ` Liam Beguin
2021-11-25  5:13     ` Vinod Koul
2021-11-25  5:13       ` Vinod Koul
2021-11-20 23:20 ` [PATCH v2 1/2] phy: qualcomm: ipq806x-usb: Fix " Bjorn Andersson
2021-11-20 23:20   ` Bjorn Andersson
2021-11-23  5:08 ` Vinod Koul
2021-11-23  5:08   ` Vinod Koul

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211120061531.410771-2-vkoul@kernel.org \
    --to=vkoul@kernel.org \
    --cc=kishon@ti.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-phy@lists.infradead.org \
    --cc=lvb@xiphos.com \
    --cc=rogerq@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.