summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
diff options
context:
space:
mode:
authorSzymon Janc <szymon@janc.net.pl>2013-02-13 22:02:14 +0100
committerJohan Hedberg <johan.hedberg@intel.com>2013-02-14 09:16:47 +0200
commit35d4c4fb446b21cc09204aff907699ea92f56557 (patch)
treeaeca32f81620206e70e45526bbcd52a7adc46902 /doc/device-api.txt
parentdf1c61b817adcd816931d540ad7f7ac0d9020635 (diff)
downloadbluez-35d4c4fb446b21cc09204aff907699ea92f56557.tar.gz
doc: Clarify device connect description
Describe behaviour when some profiles are already connected. Clarify that it returns success if at least one profile was connected.
Diffstat (limited to 'doc/device-api.txt')
-rw-r--r--doc/device-api.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt
index 66c46e56d..19d3fde41 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -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