depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
libfprint/doc/libfprint-2-sections.txt

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

279 lines
5.3 KiB
Text
Raw Normal View History

doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>drivers_api</FILE>
</SECTION>
<SECTION>
<FILE>fp-context</FILE>
<TITLE>FpContext</TITLE>
FP_TYPE_CONTEXT
FpContextClass
fp_context_new
fp_context_enumerate
fp_context_get_devices
FpContext
</SECTION>
<SECTION>
<FILE>fp-device</FILE>
FP_TYPE_DEVICE
FP_DEVICE_RETRY
FP_DEVICE_ERROR
FpDeviceType
device: Expose supported features publicly as FpDeviceFeature It can be convenient for device users to check what it supports, without having multiple functions to check each single feature. So expose this and add tests.
2021-04-09 19:31:43 +00:00
FpDeviceFeature
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
FpScanType
FpDeviceRetry
FpDeviceError
libfprint2-sections: Add missing FpFingerStatusFlags
2021-04-09 21:06:32 +00:00
FpFingerStatusFlags
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fp_device_retry_quark
fp_device_error_quark
FpEnrollProgress
Introduce an early reporting mechanism for verify and match It is a good idea to report match results early, to e.g. log in a user immediately even if more device interaction is needed. Add new _full variants for the verify/identify functions, with a corresponding callback. Also move driver result reporting into new fpi_device_{identify,verify}_report functions and remove the reporting from the fpi_device_{identify,verify}_complete calls. Basic updates to code is done in places. Only the upekts driver is actually modified from a behaviour point of view. The image driver code should be restructured quite a bit to split the reporting and only report completion after device deactivation. This should simplifiy the code quite a bit again.
2019-12-24 00:01:04 +00:00
FpMatchCb
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fp_device_get_driver
fp_device_get_device_id
fp_device_get_name
fp_device_get_scan_type
fp_device_get_nr_enroll_stages
doc: Add a few missing functions to documentation
2021-03-17 09:47:05 +00:00
fp_device_get_finger_status
device: Expose supported features publicly as FpDeviceFeature It can be convenient for device users to check what it supports, without having multiple functions to check each single feature. So expose this and add tests.
2021-04-09 19:31:43 +00:00
fp_device_get_features
fp_device_has_feature
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fp_device_has_storage
fp_device_supports_identify
fp_device_supports_capture
doc: Add a few missing functions to documentation
2021-03-17 09:47:05 +00:00
fp_device_is_open
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fp_device_open
fp_device_close
fp_device_enroll
fp_device_verify
fp_device_identify
fp_device_capture
fp_device_delete_print
fp_device_list_prints
fp-device: Add fp_device_clear_storage and clear_storage vfunc
2021-04-09 09:23:13 +00:00
fp_device_clear_storage
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fp_device_open_finish
fp_device_close_finish
fp_device_enroll_finish
fp_device_verify_finish
fp_device_identify_finish
fp_device_capture_finish
fp_device_delete_print_finish
fp_device_list_prints_finish
fp-device: Add fp_device_clear_storage and clear_storage vfunc
2021-04-09 09:23:13 +00:00
fp_device_clear_storage_finish
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fp_device_open_sync
fp_device_close_sync
fp_device_enroll_sync
fp_device_verify_sync
fp_device_identify_sync
fp_device_capture_sync
fp_device_delete_print_sync
fp_device_list_prints_sync
fp-device: Add fp_device_clear_storage and clear_storage vfunc
2021-04-09 09:23:13 +00:00
fp_device_clear_storage_sync
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
FpDevice
</SECTION>
<SECTION>
<FILE>fp-image</FILE>
FP_TYPE_IMAGE
FpMinutia
fp_image_new
fp_image_get_width
fp_image_get_height
fp_image_get_ppmm
fp_image_get_minutiae
fp_image_detect_minutiae
fp_image_detect_minutiae_finish
fp_image_get_data
fp_image_get_binarized
fp_minutia_get_coords
FpImage
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</SECTION>
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>fp-image-device</FILE>
FP_TYPE_IMAGE_DEVICE
FpImageDevice
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</SECTION>
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>fp-print</FILE>
FP_TYPE_PRINT
FpFinger
FpPrint
fp_print_new
fp_print_get_driver
fp_print_get_device_id
fp_print_get_device_stored
fp_print_get_image
fp_print_get_finger
fp_print_get_username
fp_print_get_description
fp_print_get_enroll_date
fp_print_set_finger
fp_print_set_username
fp_print_set_description
fp_print_set_enroll_date
fp_print_compatible
fp_print_equal
fp_print_serialize
fp_print_deserialize
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</SECTION>
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>fpi-assembling</FILE>
fpi_frame
fpi_frame_asmbl_ctx
fpi_do_movement_estimation
fpi_assemble_frames
fpi_line_asmbl_ctx
fpi_assemble_lines
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</SECTION>
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>fpi-context</FILE>
fpi_get_driver_types
</SECTION>
<SECTION>
<FILE>fpi-device</FILE>
FpDeviceClass
FpTimeoutFunc
cleanup: Use FPI prefix for all the internal enum types
2019-12-16 21:45:00 +00:00
FpiDeviceAction
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
FpIdEntry
Add support for udev based device discovery This is primarily useful for SPI devices. These devices sometimes needs a combination of an SPI and HID device, so discovery is a bit more complicated.
2021-04-08 14:46:01 +00:00
FpiDeviceUdevSubtypeFlags
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fpi_device_get_usb_device
Add support for udev based device discovery This is primarily useful for SPI devices. These devices sometimes needs a combination of an SPI and HID device, so discovery is a bit more complicated.
2021-04-08 14:46:01 +00:00
fpi_device_get_udev_data
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fpi_device_get_virtual_env
fpi_device_get_current_action
fpi_device_retry_new
fpi_device_error_new
fpi_device_retry_new_msg
fpi_device_error_new_msg
fpi_device_get_driver_data
fpi_device_get_enroll_data
fpi_device_get_capture_data
fpi_device_get_verify_data
fpi_device_get_identify_data
fpi_device_get_delete_data
fpi_device_get_cancellable
fpi_device_action_is_cancelled
fpi_device_add_timeout
fpi_device_set_nr_enroll_stages
fpi_device_set_scan_type
device: Add API to update features during probe This allows updating the supported feature bitfield during probe.
2021-06-25 14:13:13 +00:00
fpi_device_update_features
doc: Add a few missing functions to documentation
2021-03-17 09:47:05 +00:00
fpi_device_remove
fpi_device_report_finger_status
fpi_device_report_finger_status_changes
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fpi_device_action_error
fpi_device_probe_complete
fpi_device_open_complete
fpi_device_close_complete
fpi_device_enroll_complete
fpi_device_verify_complete
fpi_device_identify_complete
fpi_device_capture_complete
fpi_device_delete_complete
fpi_device_enroll_progress
Introduce an early reporting mechanism for verify and match It is a good idea to report match results early, to e.g. log in a user immediately even if more device interaction is needed. Add new _full variants for the verify/identify functions, with a corresponding callback. Also move driver result reporting into new fpi_device_{identify,verify}_report functions and remove the reporting from the fpi_device_{identify,verify}_complete calls. Basic updates to code is done in places. Only the upekts driver is actually modified from a behaviour point of view. The image driver code should be restructured quite a bit to split the reporting and only report completion after device deactivation. This should simplifiy the code quite a bit again.
2019-12-24 00:01:04 +00:00
fpi_device_verify_report
fpi_device_identify_report
doc: Add a few missing functions to documentation
2021-03-17 09:47:05 +00:00
fpi_device_list_complete
fpi-device: Add FpiDeviceFeature flags to FpDeviceClass Allows drivers to define more fine grained features for devices, not strictly depending on assumptions we can make depending on the implemented vfuncs. We keep this per class but could be in theory moved to each instance. In any case, added an utility function to initialize it in the way we can ensure that we've a consistent way for setting them across all the devices.
2020-12-08 03:16:31 +00:00
fpi_device_class_auto_initialize_features
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
</SECTION>
<SECTION>
<FILE>fpi-image</FILE>
FpiImageFlags
FpImage
fpi_std_sq_dev
fpi_mean_sq_diff_norm
fpi_image_resize
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</SECTION>
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>fpi-image-device</FILE>
doc: Move sections and fix title for internal FpImageDevice Otherwise the public API page (which is empty) is overwritten.
2020-05-11 18:48:11 +00:00
<TITLE>Internal FpImageDevice</TITLE>
cleanup: Use FPI prefix for all the internal enum types
2019-12-16 21:45:00 +00:00
FpiImageDeviceState
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
FpImageDeviceClass
fpi_image_device_session_error
fpi_image_device_open_complete
fpi_image_device_close_complete
fpi_image_device_activate_complete
fpi_image_device_deactivate_complete
fpi_image_device_report_finger_status
fpi_image_device_image_captured
fpi_image_device_retry_scan
doc: Add a few missing functions to documentation
2021-03-17 09:47:05 +00:00
fpi_image_device_set_bz3_threshold
doc: Port from Doxygen to gtk-doc Split the introduction into separate chapters, add filler documentation for async functions, fix mismatched function arguments.
2018-05-17 00:58:59 +00:00
</SECTION>
lib: Add Logging API documentation
2018-09-06 12:43:10 +00:00
<SECTION>
<FILE>fpi-log</FILE>
fp_dbg
fp_info
fp_warn
fp_err
BUG_ON
BUG
</SECTION>
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
<SECTION>
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<FILE>fpi-print</FILE>
cleanup: Use FPI prefix for all the internal enum types
2019-12-16 21:45:00 +00:00
FpiPrintType
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
FpiMatchResult
fpi_print_add_print
fpi_print_set_type
fpi_print_set_device_stored
fpi_print_add_from_image
fpi_print_bz3_match
print: Add helpers to generate a unique print ID containing metadata It makes sense to include this functionality in the core library as more than one driver will be using it soon.
2020-04-20 14:38:39 +00:00
fpi_print_generate_user_id
fpi_print_fill_from_user_id
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
</SECTION>
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
<SECTION>
<FILE>fpi-ssm</FILE>
FpiSsmCompletedCallback
FpiSsmHandlerCallback
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_new
fpi-ssm: Support named SSMs and use a fallback macro Add fpi_ssm_new_full() that allows to pass a name to the state-machine constructor, not to change all the drivers, provide a fpi_ssm_new() macro that stringifies the nr_parameters value (usually an enum value) as the name so that we can use it for better debugging.
2019-12-04 19:03:23 +00:00
fpi_ssm_new_full
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_free
fpi_ssm_start
fpi_ssm_start_subsm
fpi_ssm_next_state
fpi-ssm: Add possibility to jump to a state (or next one) with delay This allows to have an automatic cleanup of the timeout source when the the callback is reached and to avoid to do further state changes in the middle.
2019-11-22 16:19:27 +00:00
fpi_ssm_next_state_delayed
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_jump_to_state
fpi-ssm: Add possibility to jump to a state (or next one) with delay This allows to have an automatic cleanup of the timeout source when the the callback is reached and to avoid to do further state changes in the middle.
2019-11-22 16:19:27 +00:00
fpi_ssm_jump_to_state_delayed
fpi_ssm_cancel_delayed_state_change
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_mark_completed
lib: Rename fpi_ssm_mark_aborted to fpi_ssm_mark_failed
2018-09-05 14:29:26 +00:00
fpi_ssm_mark_failed
ssm: Make possible to set data via function Use the same approach of GTask, making possible to set the data from a function. Givent the fact that a SSM has now a device parameter, it's generally not needed to pass an extra data value. In such case make it possible to set it and to define a destroy-notify function to handle its destruction when freeing the SSM.
2019-11-20 17:05:46 +00:00
fpi_ssm_set_data
fpi_ssm_get_data
ssm: Add getter for the device In some cases it can be useful to be able to retrieve the device. Add the corresponding getter to do so.
2021-03-03 13:46:18 +00:00
fpi_ssm_get_device
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_get_error
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fpi_ssm_dup_error
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_get_cur_state
lib: Major rewrite of the libfprint core and API This is a rewrite of the core based on GObject and Gio. This commit breaks the build in a lot of ways, but basic functionality will start working again with the next commits.
2019-07-03 21:29:05 +00:00
fpi_ssm_usb_transfer_cb
FpiSsm
</SECTION>
<SECTION>
<FILE>fpi-usb-transfer</FILE>
FPI_USB_ENDPOINT_IN
FPI_USB_ENDPOINT_OUT
FpiUsbTransferCallback
FpiTransferType
FpiUsbTransfer
fpi_usb_transfer_new
fpi_usb_transfer_ref
fpi_usb_transfer_unref
fpi_usb_transfer_set_short_error
fpi_usb_transfer_fill_bulk
fpi_usb_transfer_fill_bulk_full
fpi_usb_transfer_fill_control
fpi_usb_transfer_fill_interrupt
fpi_usb_transfer_fill_interrupt_full
fpi_usb_transfer_submit
fpi_usb_transfer_submit_sync
<SUBSECTION Standard>
FPI_TYPE_USB_TRANSFER
fpi_usb_transfer_get_type
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
</SECTION>
lib: Add fpi_timeout API documentation
2018-09-05 15:33:25 +00:00
Reference in a new issue Copy permalink