depau/libfprint
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Add fpi-core and fpi-core-img sections to the docs

Browse source
This commit is contained in:
Bastien Nocera 2018-11-09 14:43:58 +01:00
parent f45c18116a
commit f2e3a840db
3 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/libfprint-docs.xml
View file

@ -40,6 +40,8 @@
<title>Writing Drivers</title>
<xi:include href="xml/fpi-log.xml"/>
<xi:include href="xml/fpi-dev.xml"/>
<xi:include href="xml/fpi-core.xml"/>
<xi:include href="xml/fpi-core-img.xml"/>
<xi:include href="xml/fpi-ssm.xml"/>
<xi:include href="xml/fpi-poll.xml"/>
<xi:include href="xml/fpi-img.xml"/>

14
doc/libfprint-sections.txt
View file

@ -197,6 +197,20 @@ fp_dev_set_instance_data
FP_INSTANCE_DATA
</SECTION>
<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>
FP_IMGDRV_SUPPORTS_UNCONDITIONAL_CAPTURE
fp_img_driver
</SECTION>
<SECTION>
<INCLUDE>fpi-img.h</INCLUDE>
<FILE>fpi-img</FILE>

19
libfprint/fpi-core.c
View file

@ -111,6 +111,25 @@ GSList *opened_devices = NULL;
* verification) on some devices which do not provide images.
*/
/**
* SECTION:fpi-core
* @title: Driver structures
*
* Driver structures need to be defined inside each driver in
* order for the core library to know what function to call, and the capabilities
* of the driver and the devices it supports.
*/
/**
* SECTION:fpi-core-img
* @title: Image driver structures
*
* Image driver structures need to be defined inside each image driver in
* order for the core library to know what function to call, and the capabilities
* of the driver and the devices it supports. Its structure is based off the
* #fp_driver struct.
*/
static GSList *registered_drivers = NULL;
static void register_driver(struct fp_driver *drv)