Documentation: Improve details of libusb_transfer's 'user_data' field
authorChris Dickens <christopher.a.dickens@gmail.com>
Tue, 18 Aug 2020 20:16:52 +0000 (13:16 -0700)
committerChris Dickens <christopher.a.dickens@gmail.com>
Tue, 18 Aug 2020 20:16:52 +0000 (13:16 -0700)
Closes #351

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

index da6b1e5..e9f5253 100644 (file)
@@ -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 */
index 0782b51..a0185be 100644 (file)
@@ -1 +1 @@
-#define LIBUSB_NANO 11543
+#define LIBUSB_NANO 11544