PERFORCE change 135735 for review

[Hans Petter Selasky]

http://perforce.freebsd.org/chv.cgi?CH=135735

Change 135735 by hselasky at hselasky_laptop001 on 2008/02/19 18:35:44

	
	Add more documentation.

Affected files ...

.. //depot/projects/usb/src/sys/dev/usb/usb_subr.c#97 edit

Differences ...

==== //depot/projects/usb/src/sys/dev/usb/usb_subr.c#97 (text+ko) ====

@@ -1034,6 +1034,10 @@
  *
  * This function selects configuration by index, independent of the
  * actual configuration number.
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 usbd_status_t
 usbd_set_config_index(struct usbd_device *udev, uint8_t index, uint8_t msg)
@@ -1191,6 +1195,10 @@
  * given interface index. The interface should not be in use when this
  * function is called. That means there should be no open USB
  * transfers. Else an error is returned.
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 usbd_status_t
 usbd_set_alt_interface_index(struct usbd_device *udev,
@@ -1221,6 +1229,10 @@
  * This function dumps information about an USB device to the
  * structure pointed to by the "di" argument. It is used by some
  * IOCTLs.
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 int
 usbd_fill_deviceinfo(struct usbd_device *udev, struct usb_device_info *di)
@@ -1708,6 +1720,10 @@
  *	usbd_suspend_resume_device
  *
  * The following function will suspend or resume the USB device.
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 usbd_status_t
 usbd_suspend_resume(struct usbd_device *udev, uint8_t do_suspend)
@@ -3198,7 +3214,7 @@
 #endif
 
 /*------------------------------------------------------------------------*
- *  usbd_make_str_desc - convert an ASCII string into a UNICODE string
+ *	usbd_make_str_desc - convert an ASCII string into a UNICODE string
  *------------------------------------------------------------------------*/
 uint8_t
 usbd_make_str_desc(void *ptr, uint16_t max_len, const char *s)
@@ -3236,7 +3252,9 @@
 }
 
 /*------------------------------------------------------------------------*
- * mtx_drop_recurse - drop mutex recurse level
+ *	mtx_drop_recurse - drop mutex recurse level
+ *
+ * Returns the recurse level of the mutex.
  *------------------------------------------------------------------------*/
 uint32_t
 mtx_drop_recurse(struct mtx *mtx)