From a97ae3bc35609e426e15746d0418217ebc19f9a4 Mon Sep 17 00:00:00 2001
From: Bastien Nocera <hadess@hadess.net>
Date: Fri, 9 Nov 2018 15:00:10 +0100
Subject: [PATCH] doc: Add fpi-async section to the docs

---
 doc/libfprint-docs.xml     |  1 +
 doc/libfprint-sections.txt | 19 +++++++++++++++++++
 libfprint/fpi-async.c      |  8 ++++++++
 3 files changed, 28 insertions(+)

diff --git a/doc/libfprint-docs.xml b/doc/libfprint-docs.xml
index ce174d1..a9705bc 100644
--- a/doc/libfprint-docs.xml
+++ b/doc/libfprint-docs.xml
@@ -43,6 +43,7 @@
     <xi:include href="xml/fpi-dev-img.xml"/>
     <xi:include href="xml/fpi-core.xml"/>
     <xi:include href="xml/fpi-core-img.xml"/>
+    <xi:include href="xml/fpi-async.xml"/>
     <xi:include href="xml/fpi-ssm.xml"/>
     <xi:include href="xml/fpi-poll.xml"/>
     <xi:include href="xml/fpi-img.xml"/>
diff --git a/doc/libfprint-sections.txt b/doc/libfprint-sections.txt
index 9a7b157..7c6c983 100644
--- a/doc/libfprint-sections.txt
+++ b/doc/libfprint-sections.txt
@@ -237,6 +237,25 @@ FP_IMGDRV_SUPPORTS_UNCONDITIONAL_CAPTURE
 fp_img_driver
 </SECTION>
 
+<SECTION>
+<INCLUDE>fpi-async.h</INCLUDE>
+<FILE>fpi-async</FILE>
+fpi_drvcb_capture_started
+fpi_drvcb_capture_stopped
+fpi_drvcb_close_complete
+fpi_drvcb_enroll_stage_completed
+fpi_drvcb_enroll_started
+fpi_drvcb_enroll_stopped
+fpi_drvcb_identify_started
+fpi_drvcb_identify_stopped
+fpi_drvcb_open_complete
+fpi_drvcb_report_capture_result
+fpi_drvcb_report_identify_result
+fpi_drvcb_report_verify_result
+fpi_drvcb_verify_started
+fpi_drvcb_verify_stopped
+</SECTION>
+
 <SECTION>
 <INCLUDE>fpi-img.h</INCLUDE>
 <FILE>fpi-img</FILE>
diff --git a/libfprint/fpi-async.c b/libfprint/fpi-async.c
index 957874a..cc1e6ed 100644
--- a/libfprint/fpi-async.c
+++ b/libfprint/fpi-async.c
@@ -26,6 +26,14 @@
 #include <errno.h>
 #include <glib.h>
 
+/**
+ * SECTION:fpi-async
+ * @title: Asynchronous operations reporting
+ *
+ * Those functions are used by primitive drivers to report back their
+ * current status. Most drivers, imaging ones, do not need to use them.
+ */
+
 /* Drivers call this when device initialisation has completed */
 void fpi_drvcb_open_complete(struct fp_dev *dev, int status)
 {