* 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

3 files changed, 22 insertions, 5 deletions

diff --git a/avahi-glib/glib-watch-test.c b/avahi-glib/glib-watch-test.c
index bd111dd..17b334d 100644
--- a/avahi-glib/glib-watch-test.c
+++ b/avahi-glib/glib-watch-test.c
@@ -33,7 +33,7 @@
 #include <avahi-common/timeval.h>
 #include "glib-watch.h"
 
-static AvahiPoll *api = NULL;
+static const AvahiPoll *api = NULL;
 static GMainLoop *loop = NULL;
 
 static void callback(AvahiWatch *w, int fd, AvahiWatchEvent event, void *userdata) {
diff --git a/avahi-glib/glib-watch.c b/avahi-glib/glib-watch.c
index 4af2390..f099e5a 100644
--- a/avahi-glib/glib-watch.c
+++ b/avahi-glib/glib-watch.c
@@ -78,7 +78,7 @@ static void cleanup(AvahiGLibPoll *g, int all) {
     g->req_cleanup = 0;
 }
 
-static AvahiWatch* watch_new(AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata) {
+static AvahiWatch* watch_new(const AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata) {
     AvahiWatch *w;
     AvahiGLibPoll *g;
     
@@ -132,7 +132,7 @@ static void watch_free(AvahiWatch *w) {
     w->glib_poll->req_cleanup = 1;
 }
 
-static void set_wakeup(AvahiPoll *api, const struct timeval *tv, AvahiWakeupCallback callback, void *userdata) {
+static void set_wakeup(const AvahiPoll *api, const struct timeval *tv, AvahiWakeupCallback callback, void *userdata) {
     AvahiGLibPoll *g;
 
     assert(api);
@@ -299,7 +299,7 @@ void avahi_glib_poll_free(AvahiGLibPoll *g) {
 /*     g_message("AFTER"); */
 }
 
-AvahiPoll* avahi_glib_poll_get(AvahiGLibPoll *g) {
+const AvahiPoll* avahi_glib_poll_get(AvahiGLibPoll *g) {
     assert(g);
 
     return &g->api;
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