sr: comments/docs

[libsigrok.git] / hwdriver.c

diff --git a/hwdriver.c b/hwdriver.c
index 7effb6aa978d81b92341fab39d14c3f07a8aab61..ff9cc5f8dc58bce17f96cdff2b4a3bdd12b62fab 100644 (file)
--- a/hwdriver.c
+++ b/hwdriver.c
@@ -148,6 +148,13 @@ SR_API int sr_driver_init(struct sr_dev_driver *driver)
 /**
  * Tell a hardware driver to scan for devices.
  *
+ * In addition to the detection, the devices that are found are also
+ * initialized automatically. On some devices, this involves a firmware upload,
+ * or other such measures.
+ *
+ * The order in which the system is scanned for devices is not specified. The
+ * caller should not assume or rely on any specific order.
+ *
  * @param driver The driver.
  * @param options A list of struct sr_hwopt options to pass to the driver's
  *             scanner.