summaryrefslogtreecommitdiff
path: root/libusb/core.c
diff options
context:
space:
mode:
authorLudovic Rousseau <ludovic.rousseau@free.fr>2022-06-08 16:31:29 +0200
committerTormod Volden <debian.tormod@gmail.com>2022-06-26 17:09:14 +0200
commit0c09ba6dafd4da2f803743c5b344b195b1338077 (patch)
tree08870b2cfe5b6eb2934887fe823ffb5c29430360 /libusb/core.c
parent69a0145d6f2505b7a76e98c29e6bc402583d2ab0 (diff)
downloadlibusb-0c09ba6dafd4da2f803743c5b344b195b1338077.tar.gz
Doxygen: Improve libusb_wrap_sys_device() documentation
Create links to: - libusb_set_option() - LIBUSB_OPTION_NO_DEVICE_DISCOVERY
Diffstat (limited to 'libusb/core.c')
-rw-r--r--libusb/core.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/libusb/core.c b/libusb/core.c
index bb7cb01..f43d71b 100644
--- a/libusb/core.c
+++ b/libusb/core.c
@@ -1209,10 +1209,11 @@ void API_EXPORTED libusb_unref_device(libusb_device *dev)
* handle for the underlying device. The handle allows you to use libusb to
* perform I/O on the device in question.
*
- * Call libusb_set_option(NULL, LIBUSB_OPTION_NO_DEVICE_DISCOVERY) before
- * libusb_init() if you want to skip enumeration of USB devices. In particular,
- * this might be needed on Android if you don't have authority to access USB
- * devices in general.
+ * Call libusb_set_option() with the parameters (NULL,
+ * \ref LIBUSB_OPTION_NO_DEVICE_DISCOVERY) before libusb_init() if you want
+ * to skip enumeration of USB devices. In particular, this might be
+ * needed on Android if you don't have authority to access USB devices
+ * in general.
*
* On Linux, the system device handle must be a valid file descriptor opened
* on the device node.