diff mbox series

[v2,1/1] usb: fotg210: Add missing kernel doc description

Message ID 20240510152641.2421298-1-andriy.shevchenko@linux.intel.com (mailing list archive)
State Accepted
Commit 4b653e82ae18f2dc91c7132b54f5785c4d56bab4
Headers show
Series [v2,1/1] usb: fotg210: Add missing kernel doc description | expand

Commit Message

Andy Shevchenko May 10, 2024, 3:26 p.m. UTC 
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(+)

Comments

Linus Walleij May 10, 2024, 4:43 p.m. UTC | #1 
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
diff mbox series

Patch

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)