]> git.hungrycats.org Git - linux/commitdiff
USB
authorGreg Kroah-Hartman <greg@kroah.com>
Mon, 8 Apr 2002 08:14:20 +0000 (01:14 -0700)
committerGreg Kroah-Hartman <greg@kroah.com>
Mon, 8 Apr 2002 08:14:20 +0000 (01:14 -0700)
cleaned up the comments to put them in proper docbook format.

drivers/usb/core/usb.c

index fbbbc865181b5b0c6ae25473049b98c79c147877..ee0a5adb0b14ee26d57efb8c7aa331e548ffd285 100644 (file)
@@ -196,14 +196,16 @@ void usb_deregister(struct usb_driver *driver)
        usbfs_update_special();
 }
 
-/*
- * usb_ifnum_to_ifpos - convert the interface _number_ (as in interface.bInterfaceNumber)
- * to the interface _position_ (as in dev->actconfig->interface + position)
+/**
+ * usb_ifnum_to_ifpos - convert the interface number to the interface position
  * @dev: the device to use
  * @ifnum: the interface number (bInterfaceNumber); not interface position
  *
- * Note that the number is the same as the position for all interfaces _except_
- * devices with interfaces not sequentially numbered (e.g., 0, 2, 3, etc).
+ * This is used to convert the interface _number_ (as in
+ * interface.bInterfaceNumber) to the interface _position_ (as in
+ * dev->actconfig->interface + position).  Note that the number is the same as
+ * the position for all interfaces _except_ devices with interfaces not
+ * sequentially numbered (e.g., 0, 2, 3, etc).
  */
 int usb_ifnum_to_ifpos(struct usb_device *dev, unsigned ifnum)
 {
@@ -590,13 +592,14 @@ out_err:
        return -1;
 }
 
-/*
- * usb_find_interface_driver_for_ifnum - convert ifnum to ifpos via
- * usb_ifnum_to_ifpos and call usb_find_interface_driver().
+/**
+ * usb_find_interface_driver_for_ifnum - finds a usb interface driver for the specified ifnum
  * @dev: the device to use
  * @ifnum: the interface number (bInterfaceNumber); not interface position!
  *
- * Note usb_find_interface_driver's ifnum parameter is actually interface position.
+ * This converts a ifnum to ifpos via a call to usb_ifnum_to_ifpos and then
+ * calls usb_find_interface_driver() with the found ifpos.  Note
+ * usb_find_interface_driver's ifnum parameter is actually interface position.
  */
 int usb_find_interface_driver_for_ifnum(struct usb_device *dev, unsigned ifnum)
 {