OSDN Git Service

doc: Fix device disconnect description
authorSzymon Janc <szymon@janc.net.pl>
Wed, 13 Feb 2013 21:45:38 +0000 (22:45 +0100)
committerJohan Hedberg <johan.hedberg@intel.com>
Thu, 14 Feb 2013 07:16:48 +0000 (09:16 +0200)
Document what Disconnect() function actually does.

doc/device-api.txt

index 19d3fde..ec126e8 100644 (file)
@@ -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