adapter-api: Document per-client discovery sessions
authorBastien Nocera <hadess@hadess.net>
Wed, 23 Feb 2022 09:00:59 +0000 (10:00 +0100)
committerAyush Garg <ayush.garg@samsung.com>
Mon, 15 May 2023 09:25:53 +0000 (14:55 +0530)
The fact that each client can start its own discovery wasn't clear from
the documentation and only becomes obvious when reading the sources.

Signed-off-by: Manika Shrivastava <manika.sh@samsung.com>
Signed-off-by: Ayush Garg <ayush.garg@samsung.com>
doc/adapter-api.txt

index 552a97c..811ff49 100755 (executable)
@@ -21,6 +21,9 @@ Methods               void StartDiscovery()
 
                        During discovery RSSI delta-threshold is imposed.
 
+                       Each client can request a single device discovery session
+                       per adapter.
+
                        Possible errors: org.bluez.Error.NotReady
                                         org.bluez.Error.Failed
                                         org.bluez.Error.InProgress
@@ -32,7 +35,8 @@ Methods               void StartDiscovery()
 
                        Note that a discovery procedure is shared between all
                        discovery sessions thus calling StopDiscovery will only
-                       release a single session.
+                       release a single session and discovery will stop when
+                       all sessions from all clients have finished.
 
                        Possible errors: org.bluez.Error.NotReady
                                         org.bluez.Error.Failed