document iface.h to ease porting

git-svn-id: file:///home/lennart/svn/public/avahi/trunk@1288 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe

1 files changed, 12 insertions, 0 deletions

diff --git a/avahi-autoipd/iface.h b/avahi-autoipd/iface.h
index 4480c97..017c90d 100644
--- a/avahi-autoipd/iface.h
+++ b/avahi-autoipd/iface.h
@@ -26,10 +26,22 @@
 
 #include "main.h"
 
+/* Subscribe to network configuration changes. The only events we are
+ * interested in are when routable addresses are removed/added to the
+ * monitored interface and when our monitored interface disappears. */
+
+
+/* Return a valid fd that we listen on for events */
 int iface_init(int ifindex);
+
+/* Process events */
 int iface_process(Event *event);
 void iface_done(void);
 
+/* Deduce the initial state of our state machine. If a routable
+ * address is configured for the interface, *state should be set to
+ * STATE_SLEEPING., otherwide STATE_START */
+
 int iface_get_initial_state(State *state);
 
 #endif