Add initial interface documentation

diff --git a/doc/Makefile.am b/doc/Makefile.am
index fadc659..33cc0bd 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
 
-EXTRA_DIST = manager-api.txt
+EXTRA_DIST = manager-api.txt interface-api.txt
 
 MAINTAINERCLEANFILES = Makefile.in

diff --git a/doc/interface-api.txt b/doc/interface-api.txt
new file mode 100644 (file)
index 0000000..1b0d468
--- /dev/null
+++ b/doc/interface-api.txt
@@ -0,0 +1,24 @@
+Interface hierarchy
+*******************
+
+Service name   org.freedesktop.connman
+Interface name org.freedesktop.connman.Interface
+Object path    [interface object]
+
+Methods                dict GetProperties()
+               string GetState()
+               uint16 GetSignal()
+               string GetPolicy()
+               void SetPolicy(string policy)
+               dict GetNetwork()
+               void SetNetwork(dict network)
+               dict GetIPv4()
+               void SetIPv4(dict ipv4)
+
+Signals                StateChanged(string state)
+               SignalChanged(uint16 signal)
+               PolicyChanged(string policy)
+               NetworkFound(dict network)
+               NetworkChanged(dict network)
+               IPv4Changed(dict ipv4)
+