Documentation: Improve details of libusb_transfer's 'user_data' field

Closes #351

Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>

diff --git a/libusb/libusb.h b/libusb/libusb.h
index da6b1e59965fa56df5e72d115e6b11e22e99b701..e9f525390dd6d2da557617b860dde4faea2c183e 100644 (file)
--- a/libusb/libusb.h
+++ b/libusb/libusb.h
@@ -1254,7 +1254,16 @@ struct libusb_transfer {
         * fails, or is cancelled. */
        libusb_transfer_cb_fn callback;
 
-       /** User context data to pass to the callback function. */
+       /** User context data. Useful for associating specific data to a transfer
+        * that can be accessed from within the callback function.
+        *
+        * This field may be set manually or is taken as the `user_data` parameter
+        * of the following functions:
+        * - libusb_fill_bulk_transfer()
+        * - libusb_fill_bulk_stream_transfer()
+        * - libusb_fill_control_transfer()
+        * - libusb_fill_interrupt_transfer()
+        * - libusb_fill_iso_transfer() */
        void *user_data;
 
        /** Data buffer */

diff --git a/libusb/version_nano.h b/libusb/version_nano.h
index 0782b5134aa1e33b38bf15246154987a50da12b0..a0185bef6cd94b7972d09a3898a433c790439987 100644 (file)
--- a/libusb/version_nano.h
+++ b/libusb/version_nano.h
@@ -1 +1 @@
-#define LIBUSB_NANO 11543
+#define LIBUSB_NANO 11544