summaryrefslogtreecommitdiff
path: root/libusb
diff options
context:
space:
mode:
authorDaniel Drake <dsd@gentoo.org>2009-09-14 08:01:24 +0100
committerDaniel Drake <dsd@gentoo.org>2009-09-14 08:01:24 +0100
commit98f1b30d24359cb3185051b8df9ebb663cc10369 (patch)
tree145e22bcea6f8caa561bed19bd903090450994a3 /libusb
parent858684f0dd25921e09565034a88709dbf6f6c61b (diff)
downloadlibusb-98f1b30d24359cb3185051b8df9ebb663cc10369.tar.gz
Clarify that timeout 0 means unlimited timeout
Diffstat (limited to 'libusb')
-rw-r--r--libusb/sync.c12
1 files changed, 6 insertions, 6 deletions
diff --git a/libusb/sync.c b/libusb/sync.c
index 72cbcf2..bd4d970 100644
--- a/libusb/sync.c
+++ b/libusb/sync.c
@@ -60,8 +60,8 @@ static void ctrl_transfer_cb(struct libusb_transfer *transfer)
* \param wLength the length field for the setup packet. The data buffer should
* be at least this size.
* \param timeout timeout (in millseconds) that this function should wait
- * before giving up due to no response being received. For no timeout, use
- * value 0.
+ * before giving up due to no response being received. For an unlimited
+ * timeout, use value 0.
* \returns on success, the number of bytes actually transferred
* \returns LIBUSB_ERROR_TIMEOUT if the transfer timed out
* \returns LIBUSB_ERROR_PIPE if the control request was not supported by the
@@ -240,8 +240,8 @@ static int do_sync_bulk_transfer(struct libusb_device_handle *dev_handle,
* \param transferred output location for the number of bytes actually
* transferred.
* \param timeout timeout (in millseconds) that this function should wait
- * before giving up due to no response being received. For no timeout, use
- * value 0.
+ * before giving up due to no response being received. For an unlimited
+ * timeout, use value 0.
*
* \returns 0 on success (and populates <tt>transferred</tt>)
* \returns LIBUSB_ERROR_TIMEOUT if the transfer timed out (and populates
@@ -290,8 +290,8 @@ API_EXPORTED int libusb_bulk_transfer(struct libusb_device_handle *dev_handle,
* \param transferred output location for the number of bytes actually
* transferred.
* \param timeout timeout (in millseconds) that this function should wait
- * before giving up due to no response being received. For no timeout, use
- * value 0.
+ * before giving up due to no response being received. For an unlimited
+ * timeout, use value 0.
*
* \returns 0 on success (and populates <tt>transferred</tt>)
* \returns LIBUSB_ERROR_TIMEOUT if the transfer timed out