From: Marcel Holtmann <marcel@holtmann.org>
Date: Tue, 9 Dec 2008 17:16:11 +0000 (+0100)
Subject: Document generic Name, Available and Remember properties
X-Git-Tag: 2.0_alpha~4502
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1cfc371f117c273f8b633dd9e5b74dd95be7ecf1;p=framework%2Fconnectivity%2Fconnman.git

Document generic Name, Available and Remember properties
---

diff --git a/doc/network-api.txt b/doc/network-api.txt
index be0cf39..9bcdf12 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -27,10 +27,25 @@ Signals		PropertyChanged(string name, variant value)
 			This signal indicates a changed value of the given
 			property.
 
-Properties	string WiFi.Name [readonly]
+Properties	string Name [readonly]
 
-			If the network type is WiFi, then this property is
-			present and contains the network name.
+			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.
+
+		boolean Available [readonly]
+
+			Indicates that this network is in range and
+			ready to be used.
+
+			The scanning process can change this property.
+
+		boolean Remember [readwrite]
+
+			Indicates that this network will be remembered.
+
+			For manually created networks this is set by
+			default.
 
 		array{byte} WiFi.SSID [readonly]