depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

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

Browse source 
Document the behaviour of fp_discover_devs() when there are no supported
devices, rather than errors listing the devices.
This commit is contained in:
Bastien Nocera 2019-01-21 15:26:56 +01:00
parent a1e46de462
commit ea6820ed51
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
libfprint/fpi-core.c
View file

@ -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)
{ {