doc: Update private network method prototypes
authorGuillaume Zajac <guillaume.zajac@linux.intel.com>
Tue, 28 Jun 2011 13:19:11 +0000 (15:19 +0200)
committerSamuel Ortiz <sameo@linux.intel.com>
Thu, 30 Jun 2011 09:59:28 +0000 (11:59 +0200)
doc/manager-api.txt

index cf26978..961c39b 100644 (file)
@@ -195,21 +195,20 @@ Methods           dict GetProperties()
                        If an application exits unexpectatly the session
                        will be automatically destroyed.
 
-               fd, dict {settings} RequestPrivateNetwork(dict options)
+               object path, dict, fd RequestPrivateNetwork(dict options)
                                                                [experimental]
 
-                       Request a new Private Network, whick includes the
+                       Request a new Private Network, which includes the
                        creation of a tun/tap interface, and IP
                        configuration, NAT and IP forwarding on that
                        interface.
-                       A file descritor to the interface is returned together
-                       with the IP, gateway and DNS settings for the
-                       interface.
+                       An object path, a dictionnary and a file descriptor
+                       with IP settings are returned.
 
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.NotSupported
 
-               void ReleasePrivateNetwork(fd) [experimental]
+               void ReleasePrivateNetwork(object path) [experimental]
 
                        Releases a private network.