[PATCH 1/2] doc: Fix device disconnect description

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Document what Disconnect() function actually does.
---
 doc/device-api.txt | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/doc/device-api.txt b/doc/device-api.txt
index 19d3fde..ec126e8 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -33,10 +33,12 @@ Methods		void Connect()
 
 		void Disconnect()
 
-			This method disconnects a specific remote device by
-			terminating the low-level ACL connection. The use of
-			this method should be restricted to administrator
-			use.
+			This method gracefully disconnects all connected
+			profiles and then terminates low-level ACL connection.
+
+			ACL connection will be terminated even if some profiles
+			were not disconnected properly e.g. due to misbehaving
+			device.
 
 			Possible errors: org.bluez.Error.NotConnected
 
-- 
1.8.1.2

--
To unsubscribe from this list: send the line "unsubscribe linux-bluetooth" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Bluez Devel]     [Linux Wireless Networking]     [Linux Wireless Personal Area Networking]     [Linux ATH6KL]     [Linux USB Devel]     [Linux Media Drivers]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux