device-api: Clarify Paired/Bonded documentation
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>
Wed, 4 May 2022 23:39:30 +0000 (16:39 -0700)
committerAyush Garg <ayush.garg@samsung.com>
Mon, 15 May 2023 09:25:54 +0000 (14:55 +0530)
This attempt to clarify the distinction of Paired and Bonded
properties.

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

index 9a743f9..f530d12 100644 (file)
@@ -225,17 +225,16 @@ Properties        string Address [readonly]
 
                boolean Paired [readonly]
 
-                       Indicates if the remote device is paired. Pairing is
-                       the process where devices exchange the information to
-                       establish an encrypted connection.
+                       Indicates if the remote device is paired. Paired means
+                       the pairing process where devices exchange the
+                       information to establish an encrypted connection has
+                       been completed.
 
                boolean Bonded [readonly]
 
                        Indicates if the remote device is bonded. Bonded means
-                       the link key or the ltk from the pairing process has
-                       been stored.
-                       A PropertiesChanged signal indicate changes to this
-                       status.
+                       the information exchanged on pairing process has been
+                       stored and will be persisted.
 
 #ifdef TIZEN_FEATURE_BLUEZ_MODIFY
                byte Connected [readonly]