From 18495d122d4cdf3632448408ca15f821f32922cb Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Tue, 23 Oct 2018 10:18:41 +0200 Subject: [PATCH] lib: Fix up @dev argument docs --- libfprint/fpi-core.c | 18 +++++++++--------- libfprint/fpi-sync.c | 2 +- libfprint/fprint.h | 10 +++++----- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/libfprint/fpi-core.c b/libfprint/fpi-core.c index eede91a..fc19757 100644 --- a/libfprint/fpi-core.c +++ b/libfprint/fpi-core.c @@ -453,7 +453,7 @@ API_EXPORTED struct fp_dscv_dev *fp_dscv_dev_for_dscv_print(struct fp_dscv_dev * /** * fp_dev_get_driver: - * @dev: the device + * @dev: the struct #fp_dev device * * Get the #fp_driver for a fingerprint device. * @@ -466,7 +466,7 @@ API_EXPORTED struct fp_driver *fp_dev_get_driver(struct fp_dev *dev) /** * fp_dev_get_nr_enroll_stages: - * @dev: the device + * @dev: the struct #fp_dev device * * Gets the number of [enroll stages](intro.html#enrollment) required to enroll a * fingerprint with the device. @@ -480,7 +480,7 @@ API_EXPORTED int fp_dev_get_nr_enroll_stages(struct fp_dev *dev) /** * fp_dev_get_devtype: - * @dev: the device + * @dev: the struct #fp_dev device * * Gets the [devtype](advanced-topics.html#device-types) for a device. * @@ -493,7 +493,7 @@ API_EXPORTED uint32_t fp_dev_get_devtype(struct fp_dev *dev) /** * fp_dev_supports_print_data: - * @dev: the device + * @dev: the struct #fp_dev device * @data: the stored print * * Determines if a stored print is compatible with a certain device. @@ -510,7 +510,7 @@ API_EXPORTED int fp_dev_supports_print_data(struct fp_dev *dev, /** * fp_dev_supports_dscv_print: - * @dev: the device + * @dev: the struct #fp_dev device * @print: the discovered print * * Determines if a #fp_dscv_print discovered print appears to be compatible @@ -599,7 +599,7 @@ API_EXPORTED int fp_driver_supports_imaging(struct fp_driver *drv) /** * fp_dev_supports_imaging: - * @dev: the fingerprint device + * @dev: the struct #fp_dev device * * Determines if a device has imaging capabilities. If a device has imaging * capabilities you are able to perform imaging operations such as retrieving @@ -617,7 +617,7 @@ API_EXPORTED int fp_dev_supports_imaging(struct fp_dev *dev) /** * fp_dev_supports_identification: - * @dev: the fingerprint device + * @dev: the struct #fp_dev device * * Determines if a device is capable of [identification](intro.html#identification) * through fp_identify_finger() and similar. Not all devices support this @@ -632,7 +632,7 @@ API_EXPORTED int fp_dev_supports_identification(struct fp_dev *dev) /** * fp_dev_get_img_width: - * @dev: the fingerprint device + * @dev: the struct #fp_dev device * * Gets the expected width of images that will be captured from the device. * This function will return -1 for devices that are not @@ -654,7 +654,7 @@ API_EXPORTED int fp_dev_get_img_width(struct fp_dev *dev) /** * fp_dev_get_img_height: - * @dev: the fingerprint device + * @dev: the struct #fp_dev device * * Gets the expected height of images that will be captured from the device. * This function will return -1 for devices that are not diff --git a/libfprint/fpi-sync.c b/libfprint/fpi-sync.c index 5b55367..54e7688 100644 --- a/libfprint/fpi-sync.c +++ b/libfprint/fpi-sync.c @@ -40,7 +40,7 @@ static void sync_open_cb(struct fp_dev *dev, int status, void *user_data) /** * fp_dev_open: - * @ddev: the discovered device to open + * @ddev: the struct #fp_dscv_dev discovered device to open * * Opens and initialises a device. This is the function you call in order * to convert a #fp_dscv_dev discovered device into an actual device handle diff --git a/libfprint/fprint.h b/libfprint/fprint.h index 6c34839..8c24970 100644 --- a/libfprint/fprint.h +++ b/libfprint/fprint.h @@ -351,7 +351,7 @@ void fp_set_debug(int level) LIBFPRINT_DEPRECATED; /** * fp_operation_stop_cb: - * @dev: the #fp_dev device + * @dev: the struct #fp_dev device * @user_data: user data passed to the callback * * Type definition for a function that will be called when fp_async_dev_close(), @@ -362,7 +362,7 @@ typedef void (*fp_operation_stop_cb)(struct fp_dev *dev, void *user_data); /** * fp_img_operation_cb: - * @dev: the #fp_dev device + * @dev: the struct #fp_dev device * @result: an #fp_verify_result for fp_async_verify_start(), or an #fp_capture_result * for fp_async_capture_start(), or a negative value on error * @img: the captured #fp_img if capture or verification was successful @@ -376,7 +376,7 @@ typedef void (*fp_img_operation_cb)(struct fp_dev *dev, int result, /** * fp_dev_open_cb: - * @dev: the #fp_dev device + * @dev: the struct #fp_dev device * @status: 0 on success, or a negative value on error * @user_data: user data passed to the callback * @@ -393,7 +393,7 @@ void fp_async_dev_close(struct fp_dev *dev, fp_operation_stop_cb callback, /** * fp_enroll_stage_cb: - * @dev: the #fp_dev device + * @dev: the struct #fp_dev device * @result: a #fp_enroll_result on success, or a negative value on failure * @print: the enrollment data from the final stage * @img: an #fp_img to free with fp_img_free() @@ -419,7 +419,7 @@ int fp_async_verify_stop(struct fp_dev *dev, fp_operation_stop_cb callback, /** * fp_identify_cb: - * @dev: the #fp_dev device + * @dev: the struct #fp_dev device * @result: a #fp_verify_result on success, or a negative value on error. * @match_offset: the array index of the matched gallery print (if any was found). * Only valid if %FP_VERIFY_MATCH was returned.