| Message ID | 20211116103951.34482-5-vkoul@kernel.org |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [1/6] phy: mvebu-cp110-utmi: Fix kernel-doc warns | expand |
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
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
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 * * 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.
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(-)