doc: Clarify UserRoutes and ServerRoutes documentation
authorJukka Rissanen <jukka.rissanen@linux.intel.com>
Fri, 23 Nov 2012 11:39:32 +0000 (13:39 +0200)
committerDaniel Wagner <daniel.wagner@bmw-carit.de>
Fri, 23 Nov 2012 12:29:41 +0000 (13:29 +0100)
As the UserRoutes is to be set by the user, then tell that
in the documentation.
Clarify also what the ServerRoutes mean.

doc/vpn-connection-api.txt

index 5fe39d342ea382c60ec27274c58645759d5377c7..9faed8a4d4cdc4c5ac211e72442deb22f12f15e7 100644 (file)
@@ -116,7 +116,7 @@ Properties  string State [readonly]
 
                        The list of nameservers set by VPN.
 
-               array{dict} UserRoutes
+               array{dict} UserRoutes [readwrite]
 
                        int ProtocolFamily
 
@@ -157,7 +157,8 @@ Properties  string State [readonly]
 
                                Gateway address of the route.
 
-                       The VPN server activated route.
+                       The VPN server activated route. These routes
+                       are pushed to connman by VPN server.
 
                There can be other properties also but as the VPN
                technologies are so different, they have different