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

docs: Add "struct #fp_dev" to the API docs

Browse source
This commit is contained in:
Bastien Nocera 2018-10-19 16:42:47 +02:00
parent b1afa9da5d
commit e113754312
1 changed files with 8 additions and 8 deletions

16
libfprint/fpi-sync.c
View file

@ -82,7 +82,7 @@ static void sync_close_cb(struct fp_dev *dev, void *user_data)
/** /**
* fp_dev_close: * fp_dev_close:
* @dev: the device to close. If %NULL, function simply returns. * @dev: the struct #fp_dev device to close. If %NULL, function simply returns.
* *
* Close a device. You must call this function when you are finished using * Close a device. You must call this function when you are finished using
* a fingerprint device. * a fingerprint device.
@ -128,7 +128,7 @@ static void enroll_stop_cb(struct fp_dev *dev, void *user_data)
/** /**
* fp_enroll_finger_img: * fp_enroll_finger_img:
* @dev: the device * @dev: the struct #fp_dev device
* @print_data: a location to return the resultant enrollment data from * @print_data: a location to return the resultant enrollment data from
* the final stage. Must be freed with fp_print_data_free() after use. * the final stage. Must be freed with fp_print_data_free() after use.
* @img: location to store the scan image. accepts %NULL for no image * @img: location to store the scan image. accepts %NULL for no image
@ -290,7 +290,7 @@ err:
/** /**
* fp_enroll_finger: * fp_enroll_finger:
* @dev: the device * @dev: the struct #fp_dev device
* @print_data: a location to return the resultant enrollment data from * @print_data: a location to return the resultant enrollment data from
* the final stage. Must be freed with fp_print_data_free() after use. * the final stage. Must be freed with fp_print_data_free() after use.
* *
@ -331,7 +331,7 @@ static void verify_stop_cb(struct fp_dev *dev, void *user_data)
/** /**
* fp_verify_finger_img: * fp_verify_finger_img:
* @dev: the device to perform the scan. * @dev: the struct #fp_dev device to perform the scan on
* @enrolled_print: the print to verify against. Must have been previously * @enrolled_print: the print to verify against. Must have been previously
* enrolled with a device compatible to the device selected to perform the scan. * enrolled with a device compatible to the device selected to perform the scan.
* @img: location to store the scan image. accepts %NULL for no image * @img: location to store the scan image. accepts %NULL for no image
@ -423,7 +423,7 @@ err:
/** /**
* fp_verify_finger: * fp_verify_finger:
* @dev: the device to perform the scan. * @dev: the struct #fp_dev device to perform the scan on
* @enrolled_print: the print to verify against. Must have been previously * @enrolled_print: the print to verify against. Must have been previously
* enrolled with a device compatible to the device selected to perform the scan. * enrolled with a device compatible to the device selected to perform the scan.
* *
@ -467,7 +467,7 @@ static void identify_stop_cb(struct fp_dev *dev, void *user_data)
/** /**
* fp_identify_finger_img: * fp_identify_finger_img:
* @dev: the device to perform the scan. * @dev: the struct #fp_dev device to perform the scan on
* @print_gallery: NULL-terminated array of pointers to the prints to * @print_gallery: NULL-terminated array of pointers to the prints to
* identify against. Each one must have been previously enrolled with a device * identify against. Each one must have been previously enrolled with a device
* compatible to the device selected to perform the scan. * compatible to the device selected to perform the scan.
@ -565,7 +565,7 @@ err:
/** /**
* fp_identify_finger: * fp_identify_finger:
* @dev: the device to perform the scan. * @dev: the struct #fp_dev device to perform the scan on
* @print_gallery: %NULL-terminated array of pointers to the prints to * @print_gallery: %NULL-terminated array of pointers to the prints to
* identify against. Each one must have been previously enrolled with a device * identify against. Each one must have been previously enrolled with a device
* compatible to the device selected to perform the scan. * compatible to the device selected to perform the scan.
@ -611,7 +611,7 @@ static void capture_stop_cb(struct fp_dev *dev, void *user_data)
} }
/** /**
* fp_dev_img_capture: * fp_dev_img_capture:
* @dev: the device * @dev: the struct #fp_dev device
* @unconditional: whether to unconditionally capture an image, or to only capture when a finger is detected * @unconditional: whether to unconditionally capture an image, or to only capture when a finger is detected
* @img: a location to return the captured image. Must be freed with * @img: a location to return the captured image. Must be freed with
* fp_img_free() after use. * fp_img_free() after use.