* remove lots of DOXYGEN_SHOULD_SKIP_THIS from the header files, use doxygen macro...

[catta] / avahi-glib / glib-watch.h

diff --git a/avahi-glib/glib-watch.h b/avahi-glib/glib-watch.h
index 9df58b57a7a5115f0874fc94e44b4e3be4d74c33..895a6866e5028a228851c2b6da254cdc477397ab 100644 (file)
--- a/avahi-glib/glib-watch.h
+++ b/avahi-glib/glib-watch.h
@@ -22,21 +22,31 @@
   USA.
 ***/
 
-#include <avahi-common/cdecl.h>
+/** \file glib-watch.h GLib main loop adapter */
 
 #include <glib.h>
+
+#include <avahi-common/cdecl.h>
 #include <avahi-common/watch.h>
 
 AVAHI_C_DECL_BEGIN
 
+/** GLib main loop adapter. You can safely cast this into a GSource */
 typedef struct AvahiGLibPoll AvahiGLibPoll;
 
-typedef void (*AvahiGLibProcessCallback)(AvahiGLibPoll *g, void *userdata);
+/** Create a new GLib main loop adapter attached to the specified
+ context. If context is NULL, the default main loop context is
+ used. You can attach as many AvahiGLibPoll objects to the same context
+ as you want. priority takes on of GLib's G_PRIORITY constants. */
+AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context, gint priority);
 
-AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context, AvahiGLibProcessCallback callback, void *userdata);
+/** Free  GLib main loop adapter */
 void avahi_glib_poll_free(AvahiGLibPoll *g);
 
-AvahiPoll* avahi_glib_poll_get(AvahiGLibPoll *g);
+/** Return the abstract poll API structure for this object. This will
+ * return the same pointer to a internally allocated structure on each
+ * call */
+const AvahiPoll *avahi_glib_poll_get(AvahiGLibPoll *g);
 
 AVAHI_C_DECL_END