[gnome-bluetooth/wip/hadess/update-docs: 4/5] lib: Add docs for has_connected_input_devices()

[Bastien Nocera <hadess src gnome org>]

commit 99137f44f503bc7677cf9713467562308d0909d1
Author: Bastien Nocera <hadess hadess net>
Date:   Thu Jan 20 16:09:57 2022 +0100

    lib: Add docs for has_connected_input_devices()

 lib/bluetooth-client.c | 10 ++++++++++
 1 file changed, 10 insertions(+)
---
diff --git a/lib/bluetooth-client.c b/lib/bluetooth-client.c
index 5697b3b4..5b62f695 100644
--- a/lib/bluetooth-client.c
+++ b/lib/bluetooth-client.c
@@ -1495,6 +1495,16 @@ bluetooth_client_connect_service_finish (BluetoothClient *client,
        return g_task_propagate_boolean (task, error);
 }
 
+/**
+ * bluetooth_client_has_connected_input_devices:
+ * @client: a #BluetoothClient
+ *
+ * Returns whether there are connected devices with the input capability.
+ * This can be used by an OS user interface to warn the user before disabling
+ * Bluetooth so that the user isn't stranded without any input devices.
+ *
+ * Returns: %TRUE if there are connected input devices.
+ **/
 gboolean
 bluetooth_client_has_connected_input_devices (BluetoothClient *client)
 {