From 4dc8aa6dfadb3db974b516dd019a7d42d6c70b10 Mon Sep 17 00:00:00 2001
From: Bastien Nocera <hadess@hadess.net>
Date: Sat, 15 Sep 2018 01:01:40 +0200
Subject: [PATCH] docs: Add fpi-dev helpers to API docs
---
doc/libfprint-docs.xml | 1 +
doc/libfprint-sections.txt | 9 +++++++++
libfprint/fpi-dev.c | 9 +++++++++
3 files changed, 19 insertions(+)
diff --git a/doc/libfprint-docs.xml b/doc/libfprint-docs.xml
index 5ca1722..6d705e5 100644
--- a/doc/libfprint-docs.xml
+++ b/doc/libfprint-docs.xml
@@ -39,6 +39,7 @@
<part>
<title>Writing Drivers</title>
<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-poll.xml"/>
</part>
diff --git a/doc/libfprint-sections.txt b/doc/libfprint-sections.txt
index 3cc33b4..8e33b1d 100644
--- a/doc/libfprint-sections.txt
+++ b/doc/libfprint-sections.txt
@@ -182,3 +182,12 @@ fpi_timeout_fn
fpi_timeout_add
fpi_timeout_cancel
</SECTION>
+
+<SECTION>
+<INCLUDE>fpi-dev.h</INCLUDE>
+<FILE>fpi-dev</FILE>
+fp_img_dev
+
+FP_DEV
+FP_IMG_DEV
+</SECTION>
diff --git a/libfprint/fpi-dev.c b/libfprint/fpi-dev.c
index 416e8d3..0eb8038 100644
--- a/libfprint/fpi-dev.c
+++ b/libfprint/fpi-dev.c
@@ -20,6 +20,15 @@
#include "fp_internal.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:
* @dev: a struct #fp_img_dev