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

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

View file

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

View file

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

View file

@ -111,6 +111,25 @@ GSList *opened_devices = NULL;
* verification) on some devices which do not provide images. * 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 GSList *registered_drivers = NULL;
static void register_driver(struct fp_driver *drv) static void register_driver(struct fp_driver *drv)