[PATCH v2] USB: ohci: ohci_pdriver.h: fix missing kernel-doc comments
From: Randy Dunlap
Date: Mon Nov 02 2026 - 20:47:21 EST
Convert comments to kernel-doc format to avoid kernel-doc warnings:
Warning: include/linux/usb/ohci_pdriver.h:32 struct member 'power_on'
not described in 'usb_ohci_pdata'
Warning: include/linux/usb/ohci_pdriver.h:32 struct member 'power_off'
not described in 'usb_ohci_pdata'
Warning: include/linux/usb/ohci_pdriver.h:32 struct member 'power_suspend'
not described in 'usb_ohci_pdata'
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
v2: move all kernel-doc comments to before the struct instead of
having them inline insidet the struct. (Alan)
Cc: Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
Cc: linux-usb@xxxxxxxxxxxxxxx
Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
include/linux/usb/ohci_pdriver.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
--- linux-next-20261102.orig/include/linux/usb/ohci_pdriver.h
+++ linux-next-20261102/include/linux/usb/ohci_pdriver.h
@@ -13,6 +13,10 @@
* @big_endian_mmio: BE registers
* @no_big_frame_no: no big endian frame_no shift
* @num_ports: number of ports
+ * @power_on: Turn on all power and clocks
+ * @power_off: Turn off all power and clocks
+ * @power_suspend: Turn on only VBUS suspend power and hotplug
+ * detection, turn off everything else
*
* These are general configuration options for the OHCI controller. All of
* these options are activating more or less workarounds for some hardware.
@@ -23,12 +27,8 @@ struct usb_ohci_pdata {
unsigned no_big_frame_no:1;
unsigned int num_ports;
- /* Turn on all power and clocks */
int (*power_on)(struct platform_device *pdev);
- /* Turn off all power and clocks */
void (*power_off)(struct platform_device *pdev);
- /* Turn on only VBUS suspend power and hotplug detection,
- * turn off everything else */
void (*power_suspend)(struct platform_device *pdev);
};