]> git.meshlink.io Git - catta/blobdiff - avahi-common/rlist.h
forgot to pull the publish_no_reverse change to the example.
[catta] / avahi-common / rlist.h
index 96c03f159968868e49508317a46d2e7af2c68ce2..9bcc1d589b18a963c1b5dfaee981fbe1cc3d6738 100644 (file)
@@ -1,38 +1,49 @@
 #ifndef foorlistfoo
 #define foorlistfoo
 
-/* $Id$ */
-
 /***
   This file is part of avahi.
+
   avahi is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as
   published by the Free Software Foundation; either version 2.1 of the
   License, or (at your option) any later version.
+
   avahi is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
   Public License for more details.
+
   You should have received a copy of the GNU Lesser General Public
   License along with avahi; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
   USA.
 ***/
 
+/** \file rlist.h A simple linked list implementation */
+
 #include "llist.h"
 
+AVAHI_C_DECL_BEGIN
+
+/** 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);
 
+AVAHI_C_DECL_END
+
 #endif