summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2022-08-09 14:54:25 +0200
committerBastien Nocera <hadess@hadess.net>2022-08-09 14:59:43 +0200
commit81ffe363a259e1060dcb1b0b4b3f2958d9b0b755 (patch)
tree71e8630a8f78d5d11fb8f97c483860ae60481639 /lib
parente6f6f4d81ba5a48d9e7861d8afbbab63926b85b7 (diff)
downloadgnome-bluetooth-81ffe363a259e1060dcb1b0b4b3f2958d9b0b755.tar.gz
lib: Better API docs for _connect_service() API
Better explain what _connect_service() does, so it's not used for devices which can't be "connected" to.
Diffstat (limited to 'lib')
-rw-r--r--lib/bluetooth-client.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/bluetooth-client.c b/lib/bluetooth-client.c
index 7e0adf4b..5dc2522a 100644
--- a/lib/bluetooth-client.c
+++ b/lib/bluetooth-client.c
@@ -1696,6 +1696,14 @@ disconnect_callback (GDBusProxy *proxy,
* @callback: (scope async): a #GAsyncReadyCallback to call when the connection is complete
* @user_data: the data to pass to callback function
*
+ * This will start the process of connecting to one of the known-connectable
+ * services on the device. This means that it could connect to all the audio
+ * services on a headset, but just to the input service on a keyboard.
+ *
+ * Broadly speaking, this will only have an effect on devices with audio and HID
+ * services, and do nothing if the device doesn't have the "connectable"
+ * property set.
+ *
* When the connection operation is finished, @callback will be called. You can
* then call bluetooth_client_connect_service_finish() to get the result of the
* operation.