docs: Address various issues leading to wrong docs

This commit is contained in:
Marco Trevisan (Treviño)
2026-02-21 05:40:12 +01:00
parent 58a40bb4a3
commit 7111218427
6 changed files with 20 additions and 7 deletions
+1
View File
@@ -75,6 +75,7 @@ fp_device_clear_storage_sync
fp_device_suspend_sync fp_device_suspend_sync
fp_device_resume_sync fp_device_resume_sync
FpDevice FpDevice
FpTemperature
</SECTION> </SECTION>
<SECTION> <SECTION>
+2 -1
View File
@@ -52,6 +52,7 @@ fp_device_get_instance_private (FpDevice *self)
/** /**
* fpi_device_class_auto_initialize_features: * fpi_device_class_auto_initialize_features:
* @device_class: An #FpDeviceClass to initialize
* *
* Initializes the #FpDeviceClass @features flags checking what device vfuncs * Initializes the #FpDeviceClass @features flags checking what device vfuncs
* are implemented. * are implemented.
@@ -1796,7 +1797,7 @@ fpi_device_suspend_completed (FpDevice *device)
* current action will be cancelled before the error is forwarded to the * current action will be cancelled before the error is forwarded to the
* application. * application.
* *
* It is recommended to set @error to #FP_ERROR_NOT_IMPLEMENTED. * It is recommended to set @error to #FP_DEVICE_ERROR_NOT_SUPPORTED.
*/ */
void void
fpi_device_suspend_complete (FpDevice *device, fpi_device_suspend_complete (FpDevice *device,
+7
View File
@@ -38,6 +38,13 @@ typedef enum {
/** /**
* FpIdEntry: * FpIdEntry:
* @pid: The USB product ID (for USB devices)
* @vid: The USB vendor ID (for USB devices)
* @virtual_envvar: Environment variable name (for virtual devices)
* @driver_data: Optional driver-specific data, defaults to 0
* @udev_types: Subtypes for udev-based devices
* @spi_acpi_id: ACPI ID (for SPI devices)
* @hid_id: HID device identifier (for HID devices)
* *
* An entry in the table of supported hardware. For USB devices, the product ID * An entry in the table of supported hardware. For USB devices, the product ID
* and vendor ID should be provided. The optional @driver_data field defaults * and vendor ID should be provided. The optional @driver_data field defaults
+1
View File
@@ -27,6 +27,7 @@
* @FPI_IMAGE_V_FLIPPED: the image is vertically flipped * @FPI_IMAGE_V_FLIPPED: the image is vertically flipped
* @FPI_IMAGE_H_FLIPPED: the image is horizontally flipped * @FPI_IMAGE_H_FLIPPED: the image is horizontally flipped
* @FPI_IMAGE_COLORS_INVERTED: the colours are inverted * @FPI_IMAGE_COLORS_INVERTED: the colours are inverted
* @FPI_IMAGE_PARTIAL: the image is a partial scan
* *
* Flags used in an #FpImage structure to describe the contained image. * Flags used in an #FpImage structure to describe the contained image.
* This is useful for image drivers as they can simply set these flags and * This is useful for image drivers as they can simply set these flags and
+8 -5
View File
@@ -196,7 +196,7 @@ fpi_print_add_from_image (FpPrint *print,
/** /**
* fpi_print_bz3_match: * fpi_print_bz3_match:
* @template: A #FpPrint containing one or more prints * @print_template: A #FpPrint containing one or more prints
* @print: A newly scanned #FpPrint to test * @print: A newly scanned #FpPrint to test
* @bz3_threshold: The BZ3 match threshold * @bz3_threshold: The BZ3 match threshold
* @error: Return location for error * @error: Return location for error
@@ -210,14 +210,17 @@ fpi_print_add_from_image (FpPrint *print,
* Returns: Whether the prints match, @error will be set if #FPI_MATCH_ERROR is returned * Returns: Whether the prints match, @error will be set if #FPI_MATCH_ERROR is returned
*/ */
FpiMatchResult FpiMatchResult
fpi_print_bz3_match (FpPrint *template, FpPrint *print, gint bz3_threshold, GError **error) fpi_print_bz3_match (FpPrint *print_template,
FpPrint *print,
gint bz3_threshold,
GError **error)
{ {
struct xyt_struct *pstruct; struct xyt_struct *pstruct;
gint probe_len; gint probe_len;
gint i; gint i;
/* XXX: Use a different error type? */ /* XXX: Use a different error type? */
if (template->type != FPI_PRINT_NBIS || print->type != FPI_PRINT_NBIS) if (print_template->type != FPI_PRINT_NBIS || print->type != FPI_PRINT_NBIS)
{ {
*error = fpi_device_error_new_msg (FP_DEVICE_ERROR_NOT_SUPPORTED, *error = fpi_device_error_new_msg (FP_DEVICE_ERROR_NOT_SUPPORTED,
"It is only possible to match NBIS type print data"); "It is only possible to match NBIS type print data");
@@ -234,11 +237,11 @@ fpi_print_bz3_match (FpPrint *template, FpPrint *print, gint bz3_threshold, GErr
pstruct = g_ptr_array_index (print->prints, 0); pstruct = g_ptr_array_index (print->prints, 0);
probe_len = bozorth_probe_init (pstruct); probe_len = bozorth_probe_init (pstruct);
for (i = 0; i < template->prints->len; i++) for (i = 0; i < print_template->prints->len; i++)
{ {
struct xyt_struct *gstruct; struct xyt_struct *gstruct;
gint score; gint score;
gstruct = g_ptr_array_index (template->prints, i); gstruct = g_ptr_array_index (print_template->prints, i);
score = bozorth_to_gallery (probe_len, pstruct, gstruct); score = bozorth_to_gallery (probe_len, pstruct, gstruct);
fp_dbg ("score %d/%d", score, bz3_threshold); fp_dbg ("score %d/%d", score, bz3_threshold);
+1 -1
View File
@@ -42,7 +42,7 @@ gboolean fpi_print_add_from_image (FpPrint *print,
FpImage *image, FpImage *image,
GError **error); GError **error);
FpiMatchResult fpi_print_bz3_match (FpPrint *temp, FpiMatchResult fpi_print_bz3_match (FpPrint *print_template,
FpPrint *print, FpPrint *print,
gint bz3_threshold, gint bz3_threshold,
GError **error); GError **error);