summaryrefslogtreecommitdiffstats
path: root/avahi-glib/glib-watch.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2005-08-14 02:33:41 +0000
committerLennart Poettering <lennart@poettering.net>2005-08-14 02:33:41 +0000
commitfcc9b0efe1accdb0edcb3143a8e15782e69383db (patch)
tree38589765599804bee4808d49d5695f8a5e7c56c4 /avahi-glib/glib-watch.h
parent7934ca5e102693ba02d9ca6dcdee4960f2ba1a64 (diff)
* doxygen documentation updates
* make AvahiPoll objects const * make poll() functions pluggable in AvahiSimplePoll git-svn-id: file:///home/lennart/svn/public/avahi/trunk@314 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
Diffstat (limited to 'avahi-glib/glib-watch.h')
-rw-r--r--avahi-glib/glib-watch.h19
1 files changed, 18 insertions, 1 deletions
diff --git a/avahi-glib/glib-watch.h b/avahi-glib/glib-watch.h
index 9e6bd68..4fa8a3b 100644
--- a/avahi-glib/glib-watch.h
+++ b/avahi-glib/glib-watch.h
@@ -22,19 +22,36 @@
USA.
***/
+/** \file glib-watch.h GLib's memory allocator for Avahi */
+
#include <glib.h>
#include <avahi-common/cdecl.h>
#include <avahi-common/watch.h>
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
AVAHI_C_DECL_BEGIN
+#endif
+/** GLib main loop adapter */
typedef struct AvahiGLibPoll AvahiGLibPoll;
+/** 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. */
AvahiGLibPoll *avahi_glib_poll_new(GMainContext *context);
+
+/** 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);
+
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
AVAHI_C_DECL_END
+#endif
#endif