Document that libusb_get_device_list() can return any libusb_error code
authorPeter Stuge <peter@stuge.se>
Wed, 14 Sep 2011 02:00:33 +0000 (04:00 +0200)
committerPeter Stuge <peter@stuge.se>
Mon, 17 Oct 2011 14:25:50 +0000 (16:25 +0200)
Fixes #87.

libusb/core.c

index 61083bf..34953a2 100644 (file)
@@ -594,8 +594,8 @@ struct libusb_device *usbi_get_device_by_session_id(struct libusb_context *ctx,
  * \param ctx the context to operate on, or NULL for the default context
  * \param list output location for a list of devices. Must be later freed with
  * libusb_free_device_list().
- * \returns the number of devices in the outputted list, or LIBUSB_ERROR_NO_MEM
- * on memory allocation failure.
+ * \returns The number of devices in the outputted list, or any
+ * \ref libusb_error according to errors encountered by the backend.
  */
 ssize_t API_EXPORTED libusb_get_device_list(libusb_context *ctx,
        libusb_device ***list)