Commit 6f18fc4b authored by Bastien Nocera's avatar Bastien Nocera

lib: Document all the internal symbols in fpi-dev.c

parent 8ca34303
...@@ -97,12 +97,27 @@ FP_INSTANCE_DATA (struct fp_dev *dev) ...@@ -97,12 +97,27 @@ FP_INSTANCE_DATA (struct fp_dev *dev)
return dev->instance_data; return dev->instance_data;
} }
/**
* fpi_dev_get_usb_dev:
* @dev: a struct #fp_dev
*
* Return the #libusb_device_handle for this device.
*/
libusb_device_handle * libusb_device_handle *
fpi_dev_get_usb_dev(struct fp_dev *dev) fpi_dev_get_usb_dev(struct fp_dev *dev)
{ {
return dev->udev; return dev->udev;
} }
/**
* fpi_dev_set_nr_enroll_stages:
* @dev: a struct #fp_dev
* @nr_enroll_stages: the number of enroll stages
*
* Sets the number of enroll stages that this device uses. This is
* usually only necessary for primitive devices which have a hard-coded
* number of enroll stages baked into their protocol.
*/
void void
fpi_dev_set_nr_enroll_stages(struct fp_dev *dev, fpi_dev_set_nr_enroll_stages(struct fp_dev *dev,
int nr_enroll_stages) int nr_enroll_stages)
...@@ -110,6 +125,14 @@ fpi_dev_set_nr_enroll_stages(struct fp_dev *dev, ...@@ -110,6 +125,14 @@ fpi_dev_set_nr_enroll_stages(struct fp_dev *dev,
dev->nr_enroll_stages = nr_enroll_stages; dev->nr_enroll_stages = nr_enroll_stages;
} }
/**
* fpi_dev_get_verify_data:
* @dev: a struct #fp_dev
*
* Returns the verify data associated with this instance of the device.
* This is usually only necessary for primitive devices which need to
* have access to the raw verify data as it might have been stored on disk.
*/
struct fp_print_data * struct fp_print_data *
fpi_dev_get_verify_data(struct fp_dev *dev) fpi_dev_get_verify_data(struct fp_dev *dev)
{ {
......
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