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

docs: Add fpi-dev helpers to API docs

Browse source
This commit is contained in:
Bastien Nocera 2018-09-15 01:01:40 +02:00
parent 161c3ccf1c
commit 4dc8aa6dfa
3 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/libfprint-docs.xml
View file

@ -39,6 +39,7 @@
<part> <part>
<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-ssm.xml"/> <xi:include href="xml/fpi-ssm.xml"/>
<xi:include href="xml/fpi-poll.xml"/> <xi:include href="xml/fpi-poll.xml"/>
</part> </part>

9
doc/libfprint-sections.txt
View file

@ -182,3 +182,12 @@ fpi_timeout_fn
fpi_timeout_add fpi_timeout_add
fpi_timeout_cancel fpi_timeout_cancel
</SECTION> </SECTION>
<SECTION>
<INCLUDE>fpi-dev.h</INCLUDE>
<FILE>fpi-dev</FILE>
fp_img_dev
FP_DEV
FP_IMG_DEV
</SECTION>

9
libfprint/fpi-dev.c
View file

@ -20,6 +20,15 @@
#include "fp_internal.h" #include "fp_internal.h"
#include <glib.h> #include <glib.h>
/**
* SECTION:fpi-dev
* @title: Device structures
*
* Those macros and functions will help get access to and from struct #fp_dev,
* and struct #fp_img_dev types, as well as get and set the instance struct
* data, eg. the structure containing the data specific to each driver.
*/
/** /**
* FP_DEV: * FP_DEV:
* @dev: a struct #fp_img_dev * @dev: a struct #fp_img_dev