lkml.org 
[lkml]   [2021]   [Nov]   [16]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 5/6] phy: ti: omap-usb2: Fix the kernel-doc style
Hi Vinod,

On Tue, Nov 16, 2021 at 04:09:50PM +0530, Vinod Koul wrote:
> 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>

Minor nit below.

Reviewed-by: Liam Beguin <liambeguin@gmail.com>

> ---
> 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..2102b7f73ffa 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

There's an extra space after the colon here.

Cheers,
Liam

> *
> * 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

\
 
 \ /
  Last update: 2021-11-16 17:44    [W:0.090 / U:2.420 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site