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

272 lines
4.5 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>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>events</FILE>
<TITLE>Initialisation and events handling</TITLE>
doc: Add LIBFPRINT_DEPRECATED to the docs
2018-11-09 14:06:54 +00:00
LIBFPRINT_DEPRECATED
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
fp_set_debug
fp_init
fp_exit
fp_pollfd
fp_handle_events_timeout
fp_handle_events
fp_get_next_timeout
fp_get_pollfds
poll: Add missing API docs for polling functions
2018-05-22 16:44:10 +00:00
fp_pollfd_added_cb
fp_pollfd_removed_cb
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
fp_set_pollfd_notifiers
</SECTION>
<SECTION>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>discovery</FILE>
<TITLE>Device discovery</TITLE>
fp_dscv_dev
fp_discover_devs
fp_dscv_devs_free
fp_dscv_dev_get_driver
fp_dscv_dev_get_devtype
lib: Make inline functions real functions Otherwise they will not be parsed by gtk-doc and documented.
2018-05-22 14:56:14 +00:00
fp_dscv_dev_get_driver_id
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
fp_dscv_dev_supports_print_data
fp_dscv_dev_supports_dscv_print
fp_dscv_dev_for_print_data
fp_dscv_dev_for_dscv_print
</SECTION>
<SECTION>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>drv</FILE>
fp_driver
fp_driver_get_name
fp_driver_get_full_name
fp_driver_get_driver_id
fp_driver_get_scan_type
lib: Add fp_driver_supports_imaging() So we don't need to open a device before checking whether it supports imaging.
2018-10-11 13:00:30 +00:00
fp_driver_supports_imaging
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>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>dev</FILE>
fp_dev
fp_scan_type
fp_capture_result
fp_enroll_result
fp_verify_result
fp_dev_get_driver
fp_dev_get_nr_enroll_stages
fp_dev_get_devtype
fp_dev_supports_print_data
fp_dev_supports_imaging
fp_dev_supports_identification
fp_dev_supports_dscv_print
fp_dev_get_img_width
fp_dev_get_img_height
docs: Document async function callbacks
2018-05-23 11:32:48 +00:00
fp_operation_stop_cb
fp_img_operation_cb
fp_dev_open_cb
fp_enroll_stage_cb
fp_identify_cb
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
fp_dev_open
fp_async_dev_open
fp_dev_close
fp_async_dev_close
fp_enroll_finger
fp_enroll_finger_img
fp_async_enroll_start
fp_async_enroll_stop
fp_verify_finger
fp_verify_finger_img
fp_async_verify_start
fp_async_verify_stop
fp_identify_finger
fp_identify_finger_img
fp_async_identify_start
fp_async_identify_stop
fp_dev_img_capture
fp_async_capture_start
fp_async_capture_stop
</SECTION>
<SECTION>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>print_data</FILE>
fp_finger
fp_print_data
fp_print_data_get_data
fp_print_data_from_data
fp_print_data_save
fp_print_data_load
fp_print_data_delete
fp_print_data_from_dscv_print
fp_print_data_free
fp_print_data_get_driver_id
fp_print_data_get_devtype
</SECTION>
<SECTION>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>dscv_print</FILE>
fp_dscv_print
fp_discover_prints
fp_dscv_prints_free
fp_dscv_print_get_driver_id
fp_dscv_print_get_devtype
fp_dscv_print_get_finger
fp_dscv_print_delete
</SECTION>
<SECTION>
doc: Add include to each section rather than globally So that we can document internal driver APIs and mention the correct include.
2018-09-05 11:21:43 +00:00
<INCLUDE>fprint.h</INCLUDE>
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
<FILE>img</FILE>
fp_img
fp_minutia
fp_img_free
fp_img_get_height
fp_img_get_width
fp_img_get_data
fp_img_save_to_file
fp_img_standardize
fp_img_binarize
fp_img_get_minutiae
lib: Add accessor for minutia coordinates Add fp_minutia_get_coords() so that debugging applications can show the detected minutiae along with the captured image. This will also help fix the positively ancient fprint_demo. See https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=907470
2018-10-08 14:43:28 +00:00
fp_minutia_get_coords
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>
<INCLUDE>fpi-log.h</INCLUDE>
<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>
<INCLUDE>fpi-ssm.h</INCLUDE>
<FILE>fpi-ssm</FILE>
fpi_ssm
ssm_completed_fn
ssm_handler_fn
fpi_ssm_new
fpi_ssm_free
fpi_ssm_start
fpi_ssm_start_subsm
fpi_ssm_next_state
lib: Add fpi_ssm_next_state_timeout_cb() helper To be used in 5 drivers.
2018-09-19 13:46:29 +00:00
fpi_ssm_next_state_timeout_cb
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_jump_to_state
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
lib: Add fpi_ssm API documentation
2018-09-05 11:11:51 +00:00
fpi_ssm_get_user_data
fpi_ssm_get_error
fpi_ssm_get_cur_state
</SECTION>
lib: Add fpi_timeout API documentation
2018-09-05 15:33:25 +00:00
<SECTION>
<INCLUDE>fpi-poll.h</INCLUDE>
<FILE>fpi-poll</FILE>
fpi_timeout
fpi_timeout_fn
fpi_timeout_add
doc: Add missing fpi_timeout_set_name() to the docs
2018-11-09 12:53:03 +00:00
fpi_timeout_set_name
lib: Add fpi_timeout API documentation
2018-09-05 15:33:25 +00:00
fpi_timeout_cancel
</SECTION>
docs: Add fpi-dev helpers to API docs
2018-09-14 23:01:40 +00:00
<SECTION>
<INCLUDE>fpi-dev.h</INCLUDE>
<FILE>fpi-dev</FILE>
fp_img_dev
FP_DEV
FP_IMG_DEV
lib: Remove fp_dev->priv Not precise enough, and it was only used in upekts to get/set the instance private struct and keep it around, so add a new, more precisely defined field to fp_dev for that.
2018-09-14 16:37:21 +00:00
fp_dev_set_instance_data
FP_INSTANCE_DATA
doc: Add more functions to fpi-dev section And rename section to match that of fpi-dev-img
2018-11-09 13:53:58 +00:00
fpi_dev_get_usb_dev
fpi_dev_get_verify_data
fpi_dev_set_nr_enroll_stages
docs: Add fpi-dev helpers to API docs
2018-09-14 23:01:40 +00:00
</SECTION>
lib: Add libusb allocation helper
2018-09-19 14:33:03 +00:00
doc: Add fpi-dev-img section to the docs
2018-11-09 13:52:11 +00:00
<SECTION>
<INCLUDE>fpi-dev-img.h</INCLUDE>
<FILE>fpi-dev-img</FILE>
fp_imgdev_action
fp_imgdev_state
fp_imgdev_enroll_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
</SECTION>
doc: Add fpi-core and fpi-core-img sections to the docs
2018-11-09 13:43:58 +00:00
<SECTION>
<INCLUDE>fpi-core.h</INCLUDE>
<FILE>fpi-core</FILE>
usb_id
fp_driver_type
</SECTION>
<SECTION>
<INCLUDE>fpi-core.h</INCLUDE>
<FILE>fpi-core-img</FILE>
lib: Transform fp_img_driver flags into a FpiImgDriverFlags enum And document it.
2018-11-12 12:59:26 +00:00
FpiImgDriverFlags
doc: Add fpi-core and fpi-core-img sections to the docs
2018-11-09 13:43:58 +00:00
fp_img_driver
</SECTION>
doc: Add fpi-img section to the docs
2018-11-09 12:52:26 +00:00
<SECTION>
<INCLUDE>fpi-img.h</INCLUDE>
<FILE>fpi-img</FILE>
lib: Transform fp_img flags into a FpiImgFlags enum And document it.
2018-11-12 12:29:00 +00:00
FpiImgFlags
doc: Add fpi-img section to the docs
2018-11-09 12:52:26 +00:00
fpi_img_new
fpi_img_new_for_imgdev
fpi_img_realloc
fpi_img_resize
fpi_std_sq_dev
fpi_mean_sq_diff_norm
</SECTION>
doc: Add fpi-assembling section to the docs
2018-11-09 13:08:04 +00:00
<SECTION>
<INCLUDE>fpi-assembling.h</INCLUDE>
<FILE>fpi-assembling</FILE>
fpi_frame
fpi_frame_asmbl_ctx
fpi_line_asmbl_ctx
fpi_do_movement_estimation
fpi_assemble_frames
fpi_assemble_lines
</SECTION>
lib: Add libusb allocation helper
2018-09-19 14:33:03 +00:00
<SECTION>
<INCLUDE>fpi-usb.h</INCLUDE>
<FILE>fpi-usb</FILE>
lib: Add USB transfer helpers Those helpers will provide more arguments in their callbacks, and handle the libusb_transfer lifecycle, making it easier to use for drivers.
2018-09-26 12:11:09 +00:00
fpi_usb_transfer
fpi_usb_transfer_cb_fn
lib: Add libusb allocation helper
2018-09-19 14:33:03 +00:00
fpi_usb_alloc
lib: Add USB transfer helpers Those helpers will provide more arguments in their callbacks, and handle the libusb_transfer lifecycle, making it easier to use for drivers.
2018-09-26 12:11:09 +00:00
fpi_usb_fill_bulk_transfer
fpi_usb_submit_transfer
fpi_usb_cancel_transfer
lib: Add libusb allocation helper
2018-09-19 14:33:03 +00:00
</SECTION>
Reference in a new issue Copy permalink