Messages in this thread | | | Date | Sat, 20 Nov 2021 12:10:18 -0500 | From | Liam Beguin <> | Subject | Re: [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> > --- > 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
I missed it before but as Bjorn pointed out in this thread, it appears the function name should end with parentheses.
Cheers, Liam
> + * > + * @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
| |