[PATCH] network-api: improve documentation
From: Paul Fertser <fercerpav@gmail.com>
Date: 2009-08-11 06:19:13
Subsystem:
the rest · Maintainer:
Linus Torvalds
Information about ways of specifying uuids and about disconnect conditions. Signed-off-by: Paul Fertser <fercerpav@gmail.com> --- doc/network-api.txt | 8 ++++++++ 1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/doc/network-api.txt b/doc/network-api.txt
index 7271193..d935863 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt@@ -17,6 +17,14 @@ Methods string Connect(string uuid) device name. Examples of the device name are bnep0, bnep1 etc. + uuid can be either one of "gn"/"panu"/"nap" (case + insensitive) or traditional string representation + of uuid or a hexadecimal number. + + The connection will be closed and network device + released either upon calling Disconnect() or when + the client disappears from the bus. + Possible errors: org.bluez.Error.AlreadyConnected org.bluez.Error.ConnectionAttemptFailed
--
1.6.0.6