X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=avahi-common%2Fwatch.h;h=31adad7e51e55a23c92cdde04b59a9d279c78253;hb=7862fd0cb20eed204be336d050dd9c4e72528d62;hp=7bab4f8fb8140f309787d06fa3303dea15ddd118;hpb=769c00f228ba0d37217aaf1424dedde390e7a01c;p=catta

diff --git a/avahi-common/watch.h b/avahi-common/watch.h
index 7bab4f8..31adad7 100644
--- a/avahi-common/watch.h
+++ b/avahi-common/watch.h
@@ -25,18 +25,16 @@
 /** \file watch.h Simplistic main loop abstraction */
 
 #include <sys/poll.h>
-#include <avahi-common/cdecl.h>
+#include <sys/time.h>
 
-#include "timeval.h"
+#include <avahi-common/cdecl.h>
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
-#endif
 
 /** An I/O watch object */
 typedef struct AvahiWatch AvahiWatch;
 
-/** An I/O watch object */
+/** A timeout watch object */
 typedef struct AvahiTimeout AvahiTimeout;
 
 /** An event polling abstraction object */
@@ -44,10 +42,10 @@ typedef struct AvahiPoll AvahiPoll;
 
 /** Type of watch events */
 typedef enum {
-    AVAHI_WATCH_IN = POLLIN,      /** Input event */
-    AVAHI_WATCH_OUT = POLLOUT,    /** Output event */
-    AVAHI_WATCH_ERR = POLLERR,    /** Error event */
-    AVAHI_WATCH_HUP = POLLHUP     /** Hangup event */
+    AVAHI_WATCH_IN = POLLIN,      /**< Input event */
+    AVAHI_WATCH_OUT = POLLOUT,    /**< Output event */
+    AVAHI_WATCH_ERR = POLLERR,    /**< Error event */
+    AVAHI_WATCH_HUP = POLLHUP     /**< Hangup event */
 } AvahiWatchEvent;
 
 /** Called whenever an I/O event happens  on an I/O watch */
@@ -57,10 +55,10 @@ typedef void (*AvahiWatchCallback)(AvahiWatch *w, int fd, AvahiWatchEvent event,
 typedef void (*AvahiTimeoutCallback)(AvahiTimeout *t, void *userdata);
 
 /** Defines an abstracted event polling API. This may be used to
- connect Avahi to other main loops. This is losely based on Unix
+ connect Avahi to other main loops. This is loosely based on Unix
  poll(2). A consumer will call watch_new() for all file descriptors it
- wants to listen for events on. In addition he can call set_wakeup()
- to define a single wakeup time.*/
+ wants to listen for events on. In addition he can call timeout_new()
+ to define time based events .*/
 struct AvahiPoll {
 
     /** Some abstract user data usable by the provider of the API */
@@ -88,16 +86,14 @@ struct AvahiPoll {
     AvahiTimeout* (*timeout_new)(const AvahiPoll *api, const struct timeval *tv, AvahiTimeoutCallback callback, void *userdata);
 
     /** Update the absolute expiration time for a timeout, If tv is
-     * null, the timeout is disabled. It is safe to call this function from an AvahiTimeoutCallback */
+     * NULL, the timeout is disabled. It is safe to call this function from an AvahiTimeoutCallback */
     void (*timeout_update)(AvahiTimeout *, const struct timeval *tv);
     
     /** Free a timeout. It is safe to call this function from an AvahiTimeoutCallback */
     void (*timeout_free)(AvahiTimeout *t);
 };
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_END
-#endif
 
 #endif