diff mbox series

usb: fotg210-udc: fix function kernel-doc comments

Message ID 20231206181335.27540-1-rdunlap@infradead.org
State New
Headers
Series usb: fotg210-udc: fix function kernel-doc comments |

Commit Message

Randy Dunlap Dec. 6, 2023, 6:13 p.m. UTC 
  Correct kernel-doc comments to prevent warnings from
scripts/kernel-doc.

fotg210-udc.c:1103: warning: Function parameter or member 'g' not described in 'fotg210_vbus_session'
fotg210-udc.c:1103: warning: Excess function parameter '_gadget' description in 'fotg210_vbus_session'
fotg210-udc.c:1103: warning: No description found for return value of 'fotg210_vbus_session'
fotg210-udc.c:1129: warning: No description found for return value of 'fotg210_phy_event'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
---
 drivers/usb/fotg210/fotg210-udc.c |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Linus Walleij Dec. 7, 2023, 10:04 a.m. UTC | #1 
On Wed, Dec 6, 2023 at 7:13 PM Randy Dunlap <rdunlap@infradead.org> wrote:

> Correct kernel-doc comments to prevent warnings from
> scripts/kernel-doc.
>
> fotg210-udc.c:1103: warning: Function parameter or member 'g' not described in 'fotg210_vbus_session'
> fotg210-udc.c:1103: warning: Excess function parameter '_gadget' description in 'fotg210_vbus_session'
> fotg210-udc.c:1103: warning: No description found for return value of 'fotg210_vbus_session'
> fotg210-udc.c:1129: warning: No description found for return value of 'fotg210_phy_event'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: linux-usb@vger.kernel.org

Reviewed-by: Linus Walleij <linus.walleij@linaro.org>

Thanks for fixing this Randy!

Yours,
Linus Walleij
diff mbox series

Patch

diff -- a/drivers/usb/fotg210/fotg210-udc.c b/drivers/usb/fotg210/fotg210-udc.c
--- a/drivers/usb/fotg210/fotg210-udc.c
+++ b/drivers/usb/fotg210/fotg210-udc.c
@@ -1094,10 +1094,10 @@  static int fotg210_udc_stop(struct usb_g
 
 /**
  * fotg210_vbus_session - Called by external transceiver to enable/disable udc
- * @_gadget: usb gadget
+ * @g: usb gadget
  * @is_active: 0 if should disable UDC VBUS, 1 if should enable
  *
- * Returns 0
+ * Returns: %0
  */
 static int fotg210_vbus_session(struct usb_gadget *g, int is_active)
 {
@@ -1122,7 +1122,7 @@  static const struct usb_gadget_ops fotg2
  *
  * Called by the USB Phy when a cable connect or disconnect is sensed.
  *
- * Returns NOTIFY_OK or NOTIFY_DONE
+ * Returns: NOTIFY_OK or NOTIFY_DONE
  */
 static int fotg210_phy_event(struct notifier_block *nb, unsigned long action,
 			     void *data)