Linux-USB Archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 1/1] usb: fotg210: Add missing kernel doc description
@ 2024-05-10 15:26 Andy Shevchenko
  2024-05-10 16:43 ` Linus Walleij
  0 siblings, 1 reply; 2+ messages in thread
From: Andy Shevchenko @ 2024-05-10 15:26 UTC (permalink / raw
  To: Uwe Kleine-König, linux-usb, linux-kernel
  Cc: Linus Walleij, Greg Kroah-Hartman, Andy Shevchenko

kernel-doc validator is not happy:

  warning: Function parameter or struct member 'fotg' not described in 'fotg210_vbus'

Add missing description.

Fixes: 3e679bde529e ("usb: fotg210-udc: Implement VBUS session")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
v2: fixed typo (LKP, Greg)
 drivers/usb/fotg210/fotg210-core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/usb/fotg210/fotg210-core.c b/drivers/usb/fotg210/fotg210-core.c
index 958fc40eae86..0655afe7f977 100644
--- a/drivers/usb/fotg210/fotg210-core.c
+++ b/drivers/usb/fotg210/fotg210-core.c
@@ -95,6 +95,7 @@ static int fotg210_gemini_init(struct fotg210 *fotg, struct resource *res,
 
 /**
  * fotg210_vbus() - Called by gadget driver to enable/disable VBUS
+ * @fotg: pointer to a private fotg210 object
  * @enable: true to enable VBUS, false to disable VBUS
  */
 void fotg210_vbus(struct fotg210 *fotg, bool enable)
-- 
2.43.0.rc1.1336.g36b5255a03ac


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH v2 1/1] usb: fotg210: Add missing kernel doc description
  2024-05-10 15:26 [PATCH v2 1/1] usb: fotg210: Add missing kernel doc description Andy Shevchenko
@ 2024-05-10 16:43 ` Linus Walleij
  0 siblings, 0 replies; 2+ messages in thread
From: Linus Walleij @ 2024-05-10 16:43 UTC (permalink / raw
  To: Andy Shevchenko
  Cc: Uwe Kleine-König, linux-usb, linux-kernel,
	Greg Kroah-Hartman

On Fri, May 10, 2024 at 5:26 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:

> kernel-doc validator is not happy:
>
>   warning: Function parameter or struct member 'fotg' not described in 'fotg210_vbus'
>
> Add missing description.
>
> Fixes: 3e679bde529e ("usb: fotg210-udc: Implement VBUS session")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
> v2: fixed typo (LKP, Greg)

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

Yours,
Linus Walleij

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-05-10 16:43 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-05-10 15:26 [PATCH v2 1/1] usb: fotg210: Add missing kernel doc description Andy Shevchenko
2024-05-10 16:43 ` Linus Walleij

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).