X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;ds=sidebyside;f=avahi-glib%2Fglib-watch.h;h=78f77428d892135fe4252bceab737221f41dde88;hb=6e9695a1e6a5f6a70195b6de37448aaf9cde8e30;hp=9e6bd68b9dff6c331f8a2dba46672f9602e137cc;hpb=4f0a5e7572a4257894b4bfede42c26d65152609e;p=catta

diff --git a/avahi-glib/glib-watch.h b/avahi-glib/glib-watch.h
index 9e6bd68..78f7742 100644
--- a/avahi-glib/glib-watch.h
+++ b/avahi-glib/glib-watch.h
@@ -22,6 +22,11 @@
   USA.
 ***/
 
+/** \file glib-watch.h GLib main loop adapter */
+
+/** \example glib-integration.c Example of how to integrate
+ * avahi use with GLIB/GTK applications */
+
 #include <glib.h>
 
 #include <avahi-common/cdecl.h>
@@ -29,11 +34,22 @@
 
 AVAHI_C_DECL_BEGIN
 
+/** GLib main loop adapter. You can safely cast this into a GSource */
 typedef struct AvahiGLibPoll AvahiGLibPoll;
 
-AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context);
+/** 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 one of GLib's G_PRIORITY constants. */
+AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context, gint priority);
+
+/** 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