]> www.infradead.org Git - users/hch/misc.git/commitdiff
thunderbolt: Update usb4_port.c function documentation
authorAlan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Wed, 27 Aug 2025 11:56:44 +0000 (13:56 +0200)
committerMika Westerberg <mika.westerberg@linux.intel.com>
Wed, 17 Sep 2025 05:33:00 +0000 (07:33 +0200)
Make usb4_port.c function documentation compliant with current kernel-doc
standards. No functional changes.

Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
drivers/thunderbolt/usb4_port.c

index 852a45fcd19d12551fbeaa2591d5e74fde93ddd8..b5e06237261b8a7f3e19b1973162327d1a241d23 100644 (file)
@@ -296,8 +296,9 @@ const struct device_type usb4_port_device_type = {
  * usb4_port_device_add() - Add USB4 port device
  * @port: Lane 0 adapter port to add the USB4 port
  *
- * Creates and registers a USB4 port device for @port. Returns the new
- * USB4 port device pointer or ERR_PTR() in case of error.
+ * Creates and registers a USB4 port device for @port.
+ *
+ * Return: Pointer to &struct usb4_port or ERR_PTR() in case of an error.
  */
 struct usb4_port *usb4_port_device_add(struct tb_port *port)
 {
@@ -356,6 +357,8 @@ void usb4_port_device_remove(struct usb4_port *usb4)
  * @usb4: USB4 port device
  *
  * Used to resume USB4 port device after sleep state.
+ *
+ * Return: %0 on success, negative errno otherwise.
  */
 int usb4_port_device_resume(struct usb4_port *usb4)
 {