OSDN Git Service

doc: Clarify device connect description
authorSzymon Janc <szymon@janc.net.pl>
Wed, 13 Feb 2013 21:02:14 +0000 (22:02 +0100)
committerJohan Hedberg <johan.hedberg@intel.com>
Thu, 14 Feb 2013 07:16:47 +0000 (09:16 +0200)
Describe behaviour when some profiles are already connected. Clarify
that it returns success if at least one profile was connected.

doc/device-api.txt

index 66c46e5..19d3fde 100644 (file)
@@ -14,7 +14,12 @@ Methods              void Connect()
                        This is a generic method to connect any profiles
                        the remote device supports that can be connected
                        to and have been flagged as auto-connectable on
-                       our side.
+                       our side. If only subset of profiles is already
+                       connected it will try to connect currently disconnected
+                       ones.
+
+                       If at least one profile was connected successfully this
+                       method will indicate success.
 
                        Possible errors: org.bluez.Error.NotReady
                                         org.bluez.Error.Failed