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

docs: Update API docs style

Browse source 
No period at the end of parameter docs.
This commit is contained in:
Bastien Nocera 2018-10-19 16:45:02 +02:00
parent e113754312
commit d113ed9d83
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
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 struct #fp_dev 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.
@ -130,10 +130,10 @@ static void enroll_stop_cb(struct fp_dev *dev, void *user_data)
* fp_enroll_finger_img: * fp_enroll_finger_img:
* @dev: the struct #fp_dev 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
* storage. If an image is returned, it must be freed with fp_img_free() after * storage. If an image is returned, it must be freed with fp_img_free() after
* use. * use
* *
* Performs an enroll stage. See [Enrolling](libfprint-Devices-operations.html#enrolling) * Performs an enroll stage. See [Enrolling](libfprint-Devices-operations.html#enrolling)
* for an explanation of enroll stages. * for an explanation of enroll stages.
@ -292,7 +292,7 @@ err:
* fp_enroll_finger: * fp_enroll_finger:
* @dev: the struct #fp_dev 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
* *
* Performs an enroll stage. See [Enrolling](libfprint-Devices-operations.html#enrolling) * Performs an enroll stage. See [Enrolling](libfprint-Devices-operations.html#enrolling)
* for an explanation of enroll stages. This function is just a shortcut to * for an explanation of enroll stages. This function is just a shortcut to
@ -333,10 +333,10 @@ static void verify_stop_cb(struct fp_dev *dev, void *user_data)
* fp_verify_finger_img: * fp_verify_finger_img:
* @dev: the struct #fp_dev device to perform the scan on * @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
* storage. If an image is returned, it must be freed with fp_img_free() after * storage. If an image is returned, it must be freed with fp_img_free() after
* use. * use
* Performs a new scan and verify it against a previously enrolled print. * Performs a new scan and verify it against a previously enrolled print.
* If the device is an imaging device, it can also return the image from * If the device is an imaging device, it can also return the image from
@ -425,7 +425,7 @@ err:
* fp_verify_finger: * fp_verify_finger:
* @dev: the struct #fp_dev device to perform the scan on * @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
* *
* Performs a new scan and verify it against a previously enrolled print. This * Performs a new scan and verify it against a previously enrolled print. This
* function is just a shortcut to calling fp_verify_finger_img() with a NULL * function is just a shortcut to calling fp_verify_finger_img() with a NULL
@ -470,13 +470,13 @@ static void identify_stop_cb(struct fp_dev *dev, void *user_data)
* @dev: the struct #fp_dev device to perform the scan on * @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
* @match_offset: output location to store the array index of the matched * @match_offset: output location to store the array index of the matched
* gallery print (if any was found). Only valid if %FP_VERIFY_MATCH was * gallery print (if any was found). Only valid if %FP_VERIFY_MATCH was
* returned. * returned
* @img: location to store the scan image. accepts %NULL for no image * @img: location to store the scan image. accepts %NULL for no image
* storage. If an image is returned, it must be freed with fp_img_free() after * storage. If an image is returned, it must be freed with fp_img_free() after
* use. * use
* Performs a new scan and attempts to identify the scanned finger against * Performs a new scan and attempts to identify the scanned finger against
* a collection of previously enrolled fingerprints. * a collection of previously enrolled fingerprints.
@ -568,10 +568,10 @@ err:
* @dev: the struct #fp_dev device to perform the scan on * @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
* @match_offset: output location to store the array index of the matched * @match_offset: output location to store the array index of the matched
* gallery print (if any was found). Only valid if %FP_VERIFY_MATCH was * gallery print (if any was found). Only valid if %FP_VERIFY_MATCH was
* returned. * returned
* Performs a new scan and attempts to identify the scanned finger against a * Performs a new scan and attempts to identify the scanned finger against a
* collection of previously enrolled fingerprints. This function is just a * collection of previously enrolled fingerprints. This function is just a
@ -614,7 +614,7 @@ static void capture_stop_cb(struct fp_dev *dev, void *user_data)
* @dev: the struct #fp_dev 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
* *
* Captures a #fp_img from a device. The returned image is the raw * Captures a #fp_img from a device. The returned image is the raw
* image provided by the device, you may wish to [standardize](libfprint-Image-operations.html#img_std) it. * image provided by the device, you may wish to [standardize](libfprint-Image-operations.html#img_std) it.
@ -628,7 +628,7 @@ static void capture_stop_cb(struct fp_dev *dev, void *user_data)
* *
* Returns: 0 on success, non-zero on error. -ENOTSUP indicates that either the * Returns: 0 on success, non-zero on error. -ENOTSUP indicates that either the
* @unconditional flag was set but the device does not support this, or that the * @unconditional flag was set but the device does not support this, or that the
* device does not support imaging. * device does not support imaging
*/ */
API_EXPORTED int fp_dev_img_capture(struct fp_dev *dev, int unconditional, API_EXPORTED int fp_dev_img_capture(struct fp_dev *dev, int unconditional,
struct fp_img **img) struct fp_img **img)