summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2012-05-17 11:21:07 -0700
committerMarcel Holtmann <marcel@holtmann.org>2012-05-17 11:21:07 -0700
commit9a6b7928d5bae8be76c014215644dfff3af13e73 (patch)
tree3c88e05b05192895e3916f1456480e0067f8ddd4 /doc
parent6f35e2c92d06da42832fce17fd484354176198a1 (diff)
downloadconnman-9a6b7928d5bae8be76c014215644dfff3af13e73.tar.gz
connman-9a6b7928d5bae8be76c014215644dfff3af13e73.tar.bz2
connman-9a6b7928d5bae8be76c014215644dfff3af13e73.zip
doc: Clarify hidden WiFi network relations with Name+Type properties
Diffstat (limited to 'doc')
-rw-r--r--doc/service-api.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/service-api.txt b/doc/service-api.txt
index 92f93b01..a75727d4 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -150,10 +150,11 @@ Properties string State [readonly]
The service name (for example "Wireless" etc.)
This name can be used for directly displaying it in
- the application. It has pure informational purpose.
+ the application. It has pure informational purpose
+ and no attempt should be made to translate it.
- For Ethernet devices and hidden WiFi networks it is
- not guaranteed that this property is present.
+ For Ethernet devices and hidden WiFi networks this
+ property is not present.
string Type [readonly]
@@ -163,6 +164,9 @@ Properties string State [readonly]
advanced properties or showing the correct icon
to the user.
+ Together with a missing Name property, this can
+ be used to identify hidden WiFi networks.
+
array{string} Security [readonly]
If the service type is WiFi, then this property is