From 6f18fc4bf43093685ab70f0656a2d49820a358a2 Mon Sep 17 00:00:00 2001
From: Bastien Nocera <hadess@hadess.net>
Date: Mon, 12 Nov 2018 14:08:07 +0100
Subject: [PATCH] lib: Document all the internal symbols in fpi-dev.c

---
 libfprint/fpi-dev.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/libfprint/fpi-dev.c b/libfprint/fpi-dev.c
index 8ad7dd5..9ded0b3 100644
--- a/libfprint/fpi-dev.c
+++ b/libfprint/fpi-dev.c
@@ -97,12 +97,27 @@ FP_INSTANCE_DATA (struct fp_dev *dev)
 	return dev->instance_data;
 }
 
+/**
+ * fpi_dev_get_usb_dev:
+ * @dev: a struct #fp_dev
+ *
+ * Return the #libusb_device_handle for this device.
+ */
 libusb_device_handle *
 fpi_dev_get_usb_dev(struct fp_dev *dev)
 {
 	return dev->udev;
 }
 
+/**
+ * fpi_dev_set_nr_enroll_stages:
+ * @dev: a struct #fp_dev
+ * @nr_enroll_stages: the number of enroll stages
+ *
+ * Sets the number of enroll stages that this device uses. This is
+ * usually only necessary for primitive devices which have a hard-coded
+ * number of enroll stages baked into their protocol.
+ */
 void
 fpi_dev_set_nr_enroll_stages(struct fp_dev *dev,
 	int nr_enroll_stages)
@@ -110,6 +125,14 @@ fpi_dev_set_nr_enroll_stages(struct fp_dev *dev,
 	dev->nr_enroll_stages = nr_enroll_stages;
 }
 
+/**
+ * fpi_dev_get_verify_data:
+ * @dev: a struct #fp_dev
+ *
+ * Returns the verify data associated with this instance of the device.
+ * This is usually only necessary for primitive devices which need to
+ * have access to the raw verify data as it might have been stored on disk.
+ */
 struct fp_print_data *
 fpi_dev_get_verify_data(struct fp_dev *dev)
 {