From 4f7e5077166d71ec91e1d44948775b895d5f171c Mon Sep 17 00:00:00 2001 From: Bastien Nocera Date: Fri, 9 Nov 2018 14:52:11 +0100 Subject: [PATCH] doc: Add fpi-dev-img section to the docs --- doc/libfprint-docs.xml | 1 + doc/libfprint-sections.txt | 22 ++++++++++++++++++++++ libfprint/fpi-dev-img.c | 9 +++++++++ 3 files changed, 32 insertions(+) diff --git a/doc/libfprint-docs.xml b/doc/libfprint-docs.xml index 21fd590..ce174d1 100644 --- a/doc/libfprint-docs.xml +++ b/doc/libfprint-docs.xml @@ -40,6 +40,7 @@ Writing Drivers + diff --git a/doc/libfprint-sections.txt b/doc/libfprint-sections.txt index ea6ee94..6dc4ee2 100644 --- a/doc/libfprint-sections.txt +++ b/doc/libfprint-sections.txt @@ -197,6 +197,28 @@ fp_dev_set_instance_data FP_INSTANCE_DATA +
+fpi-dev-img.h +fpi-dev-img +fp_imgdev_action +fp_imgdev_state +fp_imgdev_enroll_state +fp_imgdev_verify_state + +fpi_imgdev_abort_scan +fpi_imgdev_activate_complete +fpi_imgdev_close_complete +fpi_imgdev_deactivate_complete +fpi_imgdev_get_action +fpi_imgdev_get_action_result +fpi_imgdev_get_action_state +fpi_imgdev_image_captured +fpi_imgdev_open_complete +fpi_imgdev_report_finger_status +fpi_imgdev_session_error +fpi_imgdev_set_action_result +
+
fpi-core.h fpi-core diff --git a/libfprint/fpi-dev-img.c b/libfprint/fpi-dev-img.c index a61e13c..bdf4fec 100644 --- a/libfprint/fpi-dev-img.c +++ b/libfprint/fpi-dev-img.c @@ -25,6 +25,15 @@ #include "fpi-async.h" #include "fp_internal.h" +/** + * SECTION:fpi-dev-img + * @title: Image device operations + * + * As drivers work through different operations, they need to report back + * to the core as to their internal state, so errors and successes can be + * reported back to front-ends. + */ + #define MIN_ACCEPTABLE_MINUTIAE 10 #define BOZORTH3_DEFAULT_THRESHOLD 40 #define IMG_ENROLL_STAGES 5