summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2009-03-25 18:53:08 -0700
committerMarcel Holtmann <marcel@holtmann.org>2009-03-25 18:53:08 -0700
commitfa0509daa64c3543ae876472bf157339e9a2b646 (patch)
treee8be0785db1f6aaea93d5713de789c0828e51046 /doc
parent3ed3733d91b7d350c54cc3bf39e30248e1ba6320 (diff)
downloadconnman-fa0509daa64c3543ae876472bf157339e9a2b646.tar.gz
connman-fa0509daa64c3543ae876472bf157339e9a2b646.tar.bz2
connman-fa0509daa64c3543ae876472bf157339e9a2b646.zip
Document the network address property
Diffstat (limited to 'doc')
-rw-r--r--doc/network-api.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/network-api.txt b/doc/network-api.txt
index 66ad6fbd..fc4f3480 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -27,12 +27,20 @@ Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
-Properties string Name [readonly]
+Properties string Address [readonly]
+
+ The address of the network.
+
+ string Name [readonly]
The pretty/long version of the network name. For
example in case of WiFi this should be the UTF-8
valid version of the SSID.
+ This property might not be available for every
+ network. For example hidden WiFi networks will
+ not include it.
+
boolean Available [readonly]
Indicates that this network is in range and