Commit ea6820ed authored by Bastien Nocera's avatar Bastien Nocera

lib: Better docs for no devices case in fp_discover_devs()

Document the behaviour of fp_discover_devs() when there are no supported
devices, rather than errors listing the devices.
parent a1e46de4
...@@ -270,10 +270,12 @@ static struct fp_dscv_dev *discover_dev(libusb_device *udev) ...@@ -270,10 +270,12 @@ static struct fp_dscv_dev *discover_dev(libusb_device *udev)
* fp_discover_devs: * fp_discover_devs:
* *
* Scans the system and returns a list of discovered devices. This is your * Scans the system and returns a list of discovered devices. This is your
* entry point into finding a fingerprint reader to operate. * entry point into finding a fingerprint reader to operate. Note that %NULL
* is only returned on error. When there are no supported readers available,
* an empty list is returned instead.
* *
* Returns: a nul-terminated list of discovered devices. Must be freed with * Returns: a nul-terminated list of discovered devices or %NULL on error.
* fp_dscv_devs_free() after use. * Must be freed with fp_dscv_devs_free() after use.
*/ */
API_EXPORTED struct fp_dscv_dev **fp_discover_devs(void) API_EXPORTED struct fp_dscv_dev **fp_discover_devs(void)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment