From 159f71aced253cde858c047976308431dd1514ba Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 25 Sep 2005 20:24:45 +0000
Subject: documentation updates

git-svn-id: file:///home/lennart/svn/public/avahi/trunk@615 941a03a8-eaeb-0310-b9a0-b1bbd8fe43fe
---
 avahi-common/rlist.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'avahi-common/rlist.h')

diff --git a/avahi-common/rlist.h b/avahi-common/rlist.h
index 96c03f1..57b258c 100644
--- a/avahi-common/rlist.h
+++ b/avahi-common/rlist.h
@@ -22,17 +22,34 @@
   USA.
 ***/
 
+/** \file rlist.h A simple linked list implementation */
+
 #include "llist.h"
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+AVAHI_C_DECL_BEGIN
+#endif
+
+/** A doubly linked list type */
 typedef struct AvahiRList AvahiRList;
 
+/** A doubly linked list type */
 struct AvahiRList {
     AVAHI_LLIST_FIELDS(AvahiRList, rlist);
     void *data;
 };
 
+/** Prepend a new item to the beginning of the list and return the new beginning */
 AvahiRList* avahi_rlist_prepend(AvahiRList *r, void *data);
+
+/** Remove the first occurence of the specified item from the list and return the new beginning */
 AvahiRList* avahi_rlist_remove(AvahiRList *r, void *data);
+
+/** Remove the specified item from the list and return the new beginning */
 AvahiRList* avahi_rlist_remove_by_link(AvahiRList *r, AvahiRList *n);
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+AVAHI_C_DECL_END
+#endif
+
 #endif
-- 
cgit